components:
  schemas:
    ACLAdminConnectionBase:
      properties:
        adminEmail:
          default: null
          description: The user to impersonate for the admin-level operations. Currently
            only applicable to Google Drive.
          type:
          - string
          - 'null'
        dataStoreId:
          description: The ACL management connection ID.
          type: string
        domain:
          default: null
          description: The custom domain for the connection. Currently only applicable
            to SharePoint.
          type:
          - string
          - 'null'
      required:
      - dataStoreId
      type: object
      x-versionadded: v2.43
    ACLAdminConnectionList:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
          x-versionadded: v2.43
        data:
          description: The list of ACL management connections for the user organization.
          items:
            $ref: '#/components/schemas/ACLAdminConnectionResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.43
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.43
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.43
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.43
    ACLAdminConnectionResponse:
      properties:
        adminEmail:
          default: null
          description: The user to impersonate for the admin-level operations. Currently
            only applicable to Google Drive.
          type:
          - string
          - 'null'
        dataStoreId:
          description: The ACL management connection ID.
          type: string
        domain:
          default: null
          description: The custom domain for the connection. Currently only applicable
            to SharePoint.
          type:
          - string
          - 'null'
        externalConnectorType:
          description: The data provider being configured.
          enum:
          - gdrive
          - sharepoint
          type: string
      required:
      - dataStoreId
      - externalConnectorType
      type: object
      x-versionadded: v2.43
    ANY_PERMISSION:
      const: '*'
      type: string
    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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        predicted:
          description: The average prediction of the model in the bin. ``null`` if
            there are no entries in the bin.
          type:
          - number
          - 'null'
        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:
      description: The dataset metadata.
      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 that was used to compute the AOT chart.
          type: string
        datasetMetadata:
          $ref: '#/components/schemas/AOTChartMetadataDatasetMetadata'
        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 that was used to compute the AOT chart.
          type: string
        projectId:
          description: The project ID that 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 that was used to compute the AOT chart.
          type: string
        modelId:
          description: The model ID that was used to compute the AOT chart.
          type: string
        projectId:
          description: The project ID that 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'
      required:
      - bins
      - datasetId
      - modelId
      - projectId
      - resolution
      - statistics
      type: object
    AOTChartStatistics:
      description: Statistics calculated on the chart data.
      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
    APIKeySecurityScheme:
      properties:
        description:
          description: A description of the API key security scheme.
          type:
          - string
          - 'null'
        in:
          description: The location of the API key.
          enum:
          - cookie
          - header
          - query
          type: string
        name:
          description: The name of the API key parameter.
          type: string
        type:
          default: apiKey
          description: The security scheme type; must be 'apiKey'.
          enum:
          - apiKey
          type: string
      required:
      - in
      - name
      type: object
      x-versionadded: v2.46
    APINotebookCellDisplayDataOutput:
      description: Cell display data output.
      properties:
        data:
          description: A mime-type keyed dictionary of data.
          title: Data
          type: object
        metadata:
          description: Cell output metadata.
          title: Metadata
          type: object
        outputType:
          $ref: '#/components/schemas/OutputType'
      required:
      - outputType
      - data
      - metadata
      title: APINotebookCellDisplayDataOutput
      type: object
    APINotebookCellErrorOutput:
      description: Cell error output.
      properties:
        ename:
          description: The name of the error.
          title: Ename
          type: string
        evalue:
          description: The value of the error.
          title: Evalue
          type: string
        outputType:
          $ref: '#/components/schemas/OutputType'
        traceback:
          description: The traceback of the error.
          items:
            type: string
          title: Traceback
          type: array
      required:
      - outputType
      - ename
      - evalue
      - traceback
      title: APINotebookCellErrorOutput
      type: object
    APINotebookCellExecuteResultOutput:
      description: Cell execute results output.
      properties:
        data:
          description: A mime-type keyed dictionary of data.
          title: Data
          type: object
        executionCount:
          description: A result's prompt number.
          title: Executioncount
          type: integer
        metadata:
          description: Cell output metadata.
          title: Metadata
          type: object
        outputType:
          $ref: '#/components/schemas/OutputType'
      required:
      - outputType
      - data
      - metadata
      title: APINotebookCellExecuteResultOutput
      type: object
    APINotebookCellInputRequest:
      description: Cell input request.
      properties:
        outputType:
          $ref: '#/components/schemas/OutputType'
        password:
          description: Whether the input request is for a password.
          title: Password
          type: boolean
        prompt:
          description: The prompt for the input request.
          title: Prompt
          type: string
      required:
      - outputType
      - prompt
      - password
      title: APINotebookCellInputRequest
      type: object
    APINotebookCellStreamOutput:
      description: Cell stream output.
      properties:
        name:
          description: The name of the stream.
          title: Name
          type: string
        outputType:
          $ref: '#/components/schemas/OutputType'
        text:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          description: The text of the stream.
          title: Text
      required:
      - outputType
      - name
      - text
      title: APINotebookCellStreamOutput
      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
          - externalApplication
          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
          - externalApplication
          type: string
        userFullName:
          description: The full name of the recipient user.
          type: string
      required:
      - canShare
      - id
      - name
      - role
      - shareRecipientType
      type: object
    AccessRole:
      properties:
        custom:
          description: Whether the Access Role was defined by a user (and is editable)
            or by the system (and is not)
          type: boolean
        id:
          description: The ID of the access role.
          type: string
        name:
          description: The name of the access role.
          type: string
        organizationId:
          description: The organization that the Access Role is associated with. `null`
            indicates that the role is global and can be used by all organizations
          type:
          - string
          - 'null'
        permissions:
          description: An overview of the permissions included in the access role.
          items:
            $ref: '#/components/schemas/PermissionSetInfo'
          maxItems: 100
          type: array
      required:
      - custom
      - id
      - name
      - organizationId
      - permissions
      type: object
      x-versionadded: v2.36
    AccessRoleCreate:
      properties:
        name:
          description: The name of the new Access Role. Must be unique among roles
            in the organization.
          maxLength: 100
          type: string
        organizationId:
          description: The ID of the organization to associate the role with. Set
            to `null` to create a global role that is usable by all organizations.
          type:
          - string
          - 'null'
        permissions:
          $ref: '#/components/schemas/Permissions'
      required:
      - name
      - organizationId
      - permissions
      type: object
      x-versionadded: v2.36
    AccessRoleListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The access roles for this page of the query.
          items:
            $ref: '#/components/schemas/AccessRole'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    AccessRoleUpdate:
      properties:
        name:
          description: The new name for the Access Role. Must be unique among roles
            in the organization.
          maxLength: 100
          type: string
        permissions:
          $ref: '#/components/schemas/Permissions'
      type: object
      x-versionadded: v2.36
    AccessRoleUser:
      properties:
        firstName:
          description: The user's first name.
          type: string
        id:
          description: The user's ID.
          type: string
        isActive:
          description: The user's status.
          type: boolean
        lastName:
          description: The user's last name.
          type: string
        organizationId:
          description: The ID of the user's organization.
          type:
          - string
          - 'null'
        scheduledForDeletion:
          description: The user's permadelete status.
          type: boolean
        username:
          description: The user's username.
          type: string
      required:
      - firstName
      - id
      - isActive
      - lastName
      - organizationId
      - username
      type: object
      x-versionadded: v2.36
    AccessRoleUsersListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: Information about the users on this page of the query.
          items:
            $ref: '#/components/schemas/AccessRoleUser'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    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.
          type:
          - number
          - 'null'
          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'
          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.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
      required:
      - batchId
      - batchName
      - metric
      - period
      - sampleSize
      - value
      type: object
    AccuracyHealth:
      description: Accuracy health status setting.
      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: integer
          x-versionadded: v2.33
        failingThreshold:
          description: Threshold for failing status.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        measurement:
          description: Measurement for calculating accuracy health status.
          enum:
          - percent
          - value
          type:
          - string
          - 'null'
          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
          - WGS84 MAE
          - WGS84 RMSE
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        warningThreshold:
          description: Threshold for warning status.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
      type: object
    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.
      properties:
        period:
          $ref: '#/components/schemas/TimeRange'
        sampleSize:
          description: Number of predictions used to calculate the metric.
          type:
          - integer
          - 'null'
        value:
          description: Value of the metric, null if no value.
          type:
          - number
          - 'null'
        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.
          type:
          - object
          - 'null'
      required:
      - period
      - sampleSize
      - value
      type: object
    AccuracyMetric:
      properties:
        baselineSampleSize:
          description: Number of predictions used to calculate the baseline metric
            value.
          type: integer
          x-versionadded: v2.37
        baselineValue:
          description: Baseline value of the metric.
          type:
          - number
          - 'null'
        metricName:
          description: Name of the metric.
          type: string
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        percentChange:
          description: Percent of change by comparing metric value to baseline, with
            metric direction taken into account.
          type:
          - number
          - 'null'
        sampleSize:
          description: Number of predictions used to calculate the metric value.
          type: integer
          x-versionadded: v2.37
        value:
          description: Value of the metric.
          type:
          - number
          - 'null'
      required:
      - baselineSampleSize
      - baselineValue
      - metricName
      - percentChange
      - sampleSize
      - value
      type: object
      x-versionadded: v2.36
    AccuracyMetricList:
      properties:
        data:
          description: List of Accuracy Metrics.
          items:
            description: Name of the accuracy metric.
            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
            - WGS84 MAE
            - WGS84 RMSE
            type: string
          maxItems: 15
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.36
    AccuracyMetricUpdate:
      properties:
        data:
          description: List of Accuracy Metrics.
          items:
            description: Name of the accuracy metric.
            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
            - WGS84 MAE
            - WGS84 RMSE
            type: string
          maxItems: 15
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.36
    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
    AccuracyOverSpaceBaselineBucket:
      properties:
        hexagon:
          description: h3 hexagon.
          type: string
        perClass:
          description: Accuracy metric values for selected classes, only available
            for multiclass deployments.
          items:
            $ref: '#/components/schemas/AccuracyPerClass'
          maxItems: 125
          type: array
        sampleSize:
          description: Number of rows used to calculate the metric.
          type: integer
        value:
          description: Accuracy metric value.
          type:
          - number
          - 'null'
      required:
      - hexagon
      - sampleSize
      - value
      type: object
      x-versionadded: v2.35
    AccuracyOverSpaceBucket:
      properties:
        hexagon:
          description: h3 hexagon.
          type: string
        perClass:
          description: Accuracy metric values for selected classes, only available
            for multiclass deployments.
          items:
            $ref: '#/components/schemas/AccuracyPerClass'
          maxItems: 125
          type: array
        value:
          description: Accuracy metric value.
          type:
          - number
          - 'null'
      required:
      - hexagon
      - value
      type: object
      x-versionadded: v2.35
    AccuracyOverSpaceResponse:
      properties:
        baselines:
          description: Baseline accuracy per geospatial hexagon.
          items:
            $ref: '#/components/schemas/AccuracyOverSpaceBaselineBucket'
          maxItems: 1000
          type: array
        buckets:
          description: Accuracy per geospatial hexagon.
          items:
            $ref: '#/components/schemas/AccuracyOverSpaceBucket'
          maxItems: 1000
          type: array
        geoFeatureName:
          description: The name of the geospatial feature. Segmented analysis must
            be enabled for the feature specified.
          type: string
        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
          - WGS84 MAE
          - WGS84 RMSE
          type: string
        modelId:
          description: 'The ID of the model for which metrics are being retrieved. '
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
      required:
      - baselines
      - buckets
      - geoFeatureName
      - metric
      type: object
      x-versionadded: v2.35
    AccuracyOverTimePlotsBins:
      properties:
        actual:
          description: Average actual value of the target in the bin. `null` if there
            are no entries in the bin.
          type:
          - number
          - 'null'
        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.
          type:
          - integer
          - 'null'
        predicted:
          description: Average prediction of the model in the bin. `null` if there
            are no entries in the bin.
          type:
          - number
          - 'null'
        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'
      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
          type:
          - integer
          - 'null'
        holdoutMetadata:
          $ref: '#/components/schemas/DatetimeTrendPlotsBacktestMetadata'
        holdoutStatuses:
          $ref: '#/components/schemas/AccuracyOverTimePlotsStatus'
        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:
      description: Statistics calculated for the chart data.
      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
          type:
          - number
          - 'null'
      required:
      - durbinWatson
      type: object
    AccuracyOverTimePlotsStatus:
      description: Status for accuracy over time plots.
      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'
          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
          - WGS84 MAE
          - WGS84 RMSE
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/AccuracyLegacyTimeBucket'
          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.
          type:
          - number
          - 'null'
      required:
      - className
      - value
      type: object
    AccuracyResponse:
      properties:
        batchIds:
          description: ID of the batches used to calculate accuracy metrics.
          items:
            type: string
          type: array
        data:
          description: Accuracy metric data.
          items:
            $ref: '#/components/schemas/AccuracyMetric'
          maxItems: 100
          type: array
          x-versionadded: v2.36
        metrics:
          description: Accuracy metrics of the deployment. Deprecated and to be removed
            in v2.40; use data objects.
          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
          x-versiondeprecated: v2.36
        modelId:
          description: The id of the model for which metrics are being retrieved.
            Deprecated and to be removed in v2.40; use modelId in each data object.
          type: string
          x-versiondeprecated: v2.36
        period:
          $ref: '#/components/schemas/TimeRange'
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
      required:
      - data
      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.
          type:
          - number
          - 'null'
      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'
        sampleSize:
          description: Number of rows used to calculate the metric.
          type: integer
        value:
          description: Accuracy metric value.
          type:
          - number
          - 'null'
        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.
          type:
          - object
          - 'null'
          x-versiondeprecated: v2.33
      required:
      - period
      - sampleSize
      - value
      type: object
    ActionCreatedResponse:
      description: Base schema for action created responses.
      properties:
        actionId:
          description: Action ID of the notebook update request.
          title: Actionid
          type: string
      required:
      - actionId
      title: ActionCreatedResponse
      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
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
          - type: 'null'
        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'
        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:
      description: Download URLs.
      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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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).
          type:
          - integer
          - 'null'
        activationMapWidth:
          description: The width of each activation map (the number of items in each
            row of each activationValues matrix).
          type:
          - integer
          - 'null'
        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'
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          type: array
      required:
      - activationMapHeight
      - activationMapWidth
      - activationMaps
      - targetBins
      - targetValues
      type: object
    ActiveTenantsResponse:
      properties:
        data:
          description: The active organizations.
          items:
            $ref: '#/components/schemas/OrganizationsResponse'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.39
    ActiveUser:
      properties:
        fullname:
          description: The display name of the user
          type: string
        userId:
          description: The identifier of the user
          type: string
        username:
          description: The username of the user
          type: string
      required:
      - fullname
      - userId
      - username
      type: object
      x-versionadded: v2.35
    ActiveUsersResponse:
      properties:
        data:
          description: The active users.
          items:
            $ref: '#/components/schemas/ActiveUser'
          maxItems: 10000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.35
    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
          type:
          - string
          - 'null'
          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.
          type:
          - boolean
          - 'null'
          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 times this class was predicted when the actual
            class was `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:
      description: The user that created actuals data export.
      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'
          x-versionadded: v2.33
        data:
          description: An actuals data export collected data entries. Available only
            when status is SUCCEEDED.
          items:
            $ref: '#/components/schemas/ActualsDataEntry'
          type: array
          x-versionadded: v2.33
        error:
          $ref: '#/components/schemas/ActualsError'
          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'
          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:
      description: An actuals data time range definition.
      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:
      description: Error description. Appears when actuals data export job failed
        (status is FAILED).
      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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: URL to the previous page, or null if there is no such page
          type:
          - string
          - 'null'
          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
    AddFilesIntoContainerFromDataSource:
      properties:
        credentialData:
          description: The credentials to be used to authenticate with the database
            in place of the credential ID.
          oneOf:
          - $ref: '#/components/schemas/S3CredentialsFields'
        credentialId:
          description: The identifier for the set of credentials to use to authenticate
            with the database.
          type: string
        dataSourceId:
          description: The identifier of the data source to use as the source for
            the data.
          type: string
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict between an existing file\
            \ and an uploaded one.\nRENAME (default): rename an uploaded file using\
            \ \u201C<filename> (n).ext\u201D pattern.\nREPLACE: prefer an uploaded\
            \ file.\nSKIP: prefer an existing file.\nERROR: return \"HTTP 409 Conflict\"\
            \ response in case of a naming conflict."
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        prefix:
          description: Folder path to prepend to uploaded file paths. Must end with
            "/".
          type: string
        useArchiveContents:
          default: 'True'
          description: If true, extract archive contents and associate them with the
            catalog entity.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - dataSourceId
      - overwrite
      type: object
      x-versionadded: v2.42
    AddFilesIntoContainerFromFile:
      properties:
        file:
          description: The file to upload.
          format: binary
          type: string
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict between an existing file\
            \ and an uploaded one.\nRENAME (default): rename an uploaded file using\
            \ \u201C<filename> (n).ext\u201D pattern.\nREPLACE: prefer an uploaded\
            \ file.\nSKIP: prefer an existing file.\nERROR: return \"HTTP 409 Conflict\"\
            \ response in case of a naming conflict."
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        prefix:
          description: Folder path to prepend to uploaded file paths. Must end with
            "/".
          type: string
        useArchiveContents:
          default: 'True'
          description: If true, extract archive contents and associate them with the
            catalog entity.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - file
      - overwrite
      type: object
      x-versionadded: v2.42
    AddFilesIntoContainerFromUrl:
      properties:
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict between an existing file\
            \ and an uploaded one.\nRENAME (default): rename an uploaded file using\
            \ \u201C<filename> (n).ext\u201D pattern.\nREPLACE: prefer an uploaded\
            \ file.\nSKIP: prefer an existing file.\nERROR: return \"HTTP 409 Conflict\"\
            \ response in case of a naming conflict."
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        prefix:
          description: Folder path to prepend to uploaded file paths. Must end with
            "/".
          type: string
        url:
          description: The URL to download the file(s) to add to the catalog entity.
          format: url
          type: string
        useArchiveContents:
          default: 'True'
          description: If true, extract archive contents and associate them with the
            catalog entity.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - overwrite
      - url
      type: object
      x-versionadded: v2.42
    AddFromStage:
      properties:
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict between an existing file\
            \ and an uploaded one.\nRENAME (default): rename an uploaded file using\
            \ \u201C<filename> (n).ext\u201D pattern.\nREPLACE: prefer an uploaded\
            \ file.\nSKIP: prefer an existing file.\nERROR: return \"HTTP 409 Conflict\"\
            \ response in case of a naming conflict. "
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        stageId:
          description: The ID of the stage.
          type: string
      required:
      - overwrite
      - stageId
      type: object
      x-versionadded: v2.38
    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'
          maxItems: 1000
          type: array
      required:
      - count
      - data
      type: object
    AdminSampleSize:
      description: Size of a sample to propose by default when enabling Fast Registration
        workflow.
      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: 0
          maximum: 1000000
          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.
          type:
          - string
          - 'null'
        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
    AgentCapabilities:
      description: Optional capabilities supported by the agent.
      properties:
        extensions:
          description: Protocol extensions supported by the agent.
          items:
            $ref: '#/components/schemas/AgentExtension'
          maxItems: 100
          type: array
        pushNotifications:
          description: Whether the agent supports push notifications.
          type:
          - boolean
          - 'null'
        stateTransitionHistory:
          description: Whether the agent supports state transition history.
          type:
          - boolean
          - 'null'
        streaming:
          description: Whether the agent supports streaming responses.
          type:
          - boolean
          - 'null'
      type: object
      x-versionadded: v2.46
    AgentCard:
      description: Plain agent card data.
      properties:
        additionalInterfaces:
          description: Additional transport interfaces beyond the primary URL.
          items:
            $ref: '#/components/schemas/AgentInterface'
          maxItems: 100
          type: array
        capabilities:
          $ref: '#/components/schemas/AgentCapabilities'
        defaultInputModes:
          description: Default MIME types or modes accepted as input.
          items:
            type: string
          maxItems: 100
          type: array
        defaultOutputModes:
          description: Default MIME types or modes produced as output.
          items:
            type: string
          maxItems: 100
          type: array
        description:
          description: A human-readable description of the agent.
          type: string
        documentationUrl:
          description: URL to the agent's documentation.
          type:
          - string
          - 'null'
        iconUrl:
          description: URL to an icon representing the agent.
          type:
          - string
          - 'null'
        name:
          description: The display name of the agent.
          type: string
        preferredTransport:
          default: JSONRPC
          description: Preferred transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).
            Defaults to 'JSONRPC'.
          type:
          - string
          - 'null'
        protocolVersion:
          default: 0.3.0
          description: The A2A protocol version. Defaults to '0.3.0'.
          type:
          - string
          - 'null'
        provider:
          $ref: '#/components/schemas/AgentProvider'
        security:
          description: Global security requirements. Each entry maps a scheme name
            to required scopes.
          items:
            $ref: '#/components/schemas/AllowExtra'
          maxItems: 100
          type: array
        securitySchemes:
          additionalProperties:
            oneOf:
            - $ref: '#/components/schemas/APIKeySecurityScheme'
            - $ref: '#/components/schemas/HTTPAuthSecurityScheme'
            - $ref: '#/components/schemas/OAuth2SecurityScheme'
            - $ref: '#/components/schemas/OpenIdConnectSecurityScheme'
            - $ref: '#/components/schemas/MutualTLSSecurityScheme'
          description: Map of security scheme names to their definitions.
          type: object
        signatures:
          description: JWS signatures over this agent card.
          items:
            $ref: '#/components/schemas/AgentCardSignature'
          maxItems: 100
          type: array
        skills:
          description: The list of skills this agent can perform.
          items:
            $ref: '#/components/schemas/AgentSkill'
          maxItems: 100
          type: array
        supportsAuthenticatedExtendedCard:
          description: Whether the agent exposes an authenticated extended card.
          type:
          - boolean
          - 'null'
        url:
          description: The primary endpoint URL for the agent.
          type: string
        version:
          description: The version of the agent (e.g. '1.0.0').
          type: string
      required:
      - capabilities
      - defaultInputModes
      - defaultOutputModes
      - description
      - name
      - skills
      - url
      - version
      type: object
      x-versionadded: v2.46
    AgentCardListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of formatted agent cards.
          items:
            $ref: '#/components/schemas/AgentCardResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.46
    AgentCardResponse:
      properties:
        agentCard:
          $ref: '#/components/schemas/AgentCard'
        createdAt:
          description: The date and time of when agent has been deployed and it's
            agent card registered, in ISO 8601 format
          format: date-time
          type: string
        deploymentId:
          description: The ID of the agent deployment.
          type: string
        externalId:
          description: External ID of the agent.
          type:
          - string
          - 'null'
        id:
          description: The ID of the agent card.
          type: string
        tenantId:
          description: The id of the tenant agent card is registered in.
          maxLength: 36
          minLength: 32
          type:
          - string
          - 'null'
        updatedAt:
          description: The date and time of when agent card has been last updated.
          format: date-time
          type: string
      required:
      - agentCard
      - createdAt
      - deploymentId
      - id
      - updatedAt
      type: object
      x-versionadded: v2.46
    AgentCardSignature:
      properties:
        header:
          $ref: '#/components/schemas/AllowExtra'
        protected:
          description: The base64url-encoded JWS protected header.
          type: string
        signature:
          description: The base64url-encoded JWS signature value.
          type: string
      required:
      - protected
      - signature
      type: object
      x-versionadded: v2.46
    AgentChatCompletionRequest:
      additionalProperties: true
      description: Represents a chat completion request for an agent.
      properties:
        customModelVersionId:
          anyOf:
          - type: string
          - type: 'null'
          description: The version ID of the custom model to use for the chat completion.
          title: customModelVersionId
        messages:
          description: A list of messages comprising the conversation so far.
          items:
            $ref: '#/components/schemas/AgentMessage'
          title: messages
          type: array
        model:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The model identifier to use for completion following OpenAI
            API notation.
          title: model
        tracingContext:
          anyOf:
          - $ref: '#/components/schemas/AgentTracingContext'
          - type: 'null'
          description: Optional tracing context for the chat completion request.
      required:
      - messages
      title: AgentChatCompletionRequest
      type: object
    AgentChatCompletionResponse:
      additionalProperties: true
      description: Chat completion response from an agent.
      properties:
        choices:
          anyOf:
          - items:
              $ref: '#/components/schemas/AgentChoice'
            type: array
          - type: 'null'
          description: A list of agent choices. Can be more than one. None when failed.
          title: choices
        errorDetails:
          anyOf:
          - type: string
          - type: 'null'
          description: Detailed error information if the chat completion failed.
          title: errorDetails
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: Error message if the chat completion failed.
          title: errorMessage
      title: AgentChatCompletionResponse
      type: object
    AgentChoice:
      additionalProperties: true
      description: Represents a single choice in the chat completion response.
      properties:
        message:
          $ref: '#/components/schemas/AgentMessage'
          description: The message content of the choice.
      required:
      - message
      title: AgentChoice
      type: object
    AgentExtension:
      properties:
        description:
          description: A human-readable description of the extension.
          type:
          - string
          - 'null'
        params:
          $ref: '#/components/schemas/AllowExtra'
        required:
          description: Whether this extension is required by the agent.
          type:
          - boolean
          - 'null'
        uri:
          description: The URI identifying the extension.
          type: string
      required:
      - uri
      type: object
      x-versionadded: v2.46
    AgentInterface:
      properties:
        transport:
          description: The transport protocol (e.g. JSONRPC, GRPC, HTTP+JSON).
          type: string
        url:
          description: The URL for this transport interface.
          type: string
      required:
      - transport
      - url
      type: object
      x-versionadded: v2.46
    AgentMessage:
      additionalProperties: true
      description: Represents a message in a chat conversation.
      properties:
        content:
          anyOf:
          - maxLength: 50000
            type: string
          - type: 'null'
          description: The contents of the message.
          title: content
        role:
          description: The role of the author of this message.
          title: role
          type: string
      required:
      - role
      title: AgentMessage
      type: object
    AgentProvider:
      description: The service provider of the agent.
      properties:
        organization:
          description: The organization name of the agent provider.
          type: string
        url:
          description: The URL of the agent provider.
          type: string
      required:
      - organization
      - url
      type: object
      x-versionadded: v2.46
    AgentSkill:
      properties:
        description:
          description: A human-readable description of the skill.
          type: string
        examples:
          description: Example prompts or inputs for the skill.
          items:
            type: string
          maxItems: 100
          type: array
        id:
          description: Unique identifier for the skill.
          type: string
        inputModes:
          description: MIME types or modes accepted as input.
          items:
            type: string
          maxItems: 100
          type: array
        name:
          description: The display name of the skill.
          type: string
        outputModes:
          description: MIME types or modes produced as output.
          items:
            type: string
          maxItems: 100
          type: array
        security:
          description: Security requirements for the skill. Each entry maps a scheme
            name to required scopes.
          items:
            $ref: '#/components/schemas/AllowExtra'
          maxItems: 100
          type: array
        tags:
          description: Categorization tags for the skill.
          items:
            type: string
          maxItems: 100
          type: array
      required:
      - description
      - id
      - name
      - tags
      type: object
      x-versionadded: v2.46
    AgentTracingContext:
      description: Represents a custom tracing context for a chat completion request.
      properties:
        attributes:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          description: The attributes of the tracing context.
          title: attributes
        entityId:
          description: The ID of the entity in context of which the agent request
            is performed. Should be an entity which user has access to.
          title: entityId
          type: string
        entityType:
          $ref: '#/components/schemas/TracingContextEntityType'
          description: The type of an entity in context of which the agent request
            is performed. Should be an entity which user has access to.
      required:
      - entityId
      - entityType
      - attributes
      title: AgentTracingContext
      type: object
    AggregateDirectiveArguments:
      description: The aggregation description.
      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
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - aggregations
      - groupBy
      - skip
      type: object
    AggregatedAggregationValue:
      description: Aggregated record of multiple of the same item across different
        metric aggregation runs.
      properties:
        count:
          description: The number of metric aggregation items aggregated.
          title: count
          type: integer
        item:
          description: The name of the item.
          title: item
          type: string
        value:
          description: The value associated with the item.
          title: value
          type: number
      required:
      - item
      - value
      - count
      title: AggregatedAggregationValue
      type: object
    Aggregation:
      properties:
        feature:
          default: null
          description: The feature.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        functions:
          description: The functions.
          items:
            enum:
            - sum
            - min
            - max
            - count
            - count-distinct
            - stddev
            - avg
            - most-frequent
            - median
            type: string
          minItems: 1
          type: array
          x-versionadded: v2.33
      required:
      - functions
      type: object
    AggregationType:
      description: The type of the metric aggregation.
      enum:
      - average
      - percentYes
      - classPercentCoverage
      - ngramImportance
      - guardConditionPercentYes
      title: AggregationType
      type: string
    AggregationValue:
      description: An individual record in an itemized metric aggregation.
      properties:
        item:
          description: The name of the item.
          title: item
          type: string
        value:
          description: The value associated with the item.
          title: value
          type: number
      required:
      - item
      - value
      title: AggregationValue
      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
          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.
          type:
          - string
          - 'null'
          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
          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
          type:
          - integer
          - 'null'
        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: {}
        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
        customMetricsLossesInfo:
          $ref: '#/components/schemas/CustomScoringMetricsInfo'
          x-versionadded: v2.44
        cvHoldoutLevel:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
          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.
        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.
          type:
          - string
          - 'null'
          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: The threshold value of the fairness metric. The valid range
            is [0:1]; the default fairness metric value is 0.8. This metric is only
            applicable if the *Bias & Fairness in AutoML* feature is enabled.
          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.
          type:
          - string
          - 'null'
          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
        forecastDistance:
          description: The name of a column specifying the forecast distance to which
            each row of the dataset belongs. 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.35
        forecastOffsets:
          description: An array of strings with names of a columns specifying row
            offsets. 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.35
        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
        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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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
        numberOfIncrementalLearningIterationsBeforeBestModelSelection:
          description: Number of incremental_learning iterations before best model
            selection.
          maximum: 10
          minimum: 1
          type: integer
          x-versionadded: v2.35
        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.
          type:
          - string
          - 'null'
        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: 1.0
          exclusiveMinimum: 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.
          type:
          - string
          - 'null'
          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: 0
          maximum: 100
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        seriesId:
          description: The name of a column specifying the series ID to which each
            row of the dataset belongs. Typically the series 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.35
        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
          type:
          - string
          - 'null'
          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:
      description: Statistics for all data for different feature values.
      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:
      description: Statistics for all data for different feature values.
      properties:
        missingRowsPercent:
          description: A percentage of all rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          type:
          - number
          - 'null'
        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:
      description: The parameters submitted by the user to the failed job.
      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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        endDate:
          description: 'ISO-formatted last timestamp in the subset. For example: ``2019-08-30T00:00:00.000000Z``.'
          format: date-time
          type:
          - string
          - 'null'
        latestExplanationsLocation:
          description: URL to retrieve the latest predictions with the shap explanations.
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - number
          - 'null'
        previewLocation:
          description: URL to retrieve predictions preview for the record.
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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
          - 'null'
        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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          type:
          - string
          - 'null'
      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.
          type:
          - integer
          - 'null'
        predicted:
          description: Average prediction of the model in the bin. `null` if there
            are no entries in the bin.
          type:
          - number
          - 'null'
        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'
        holdoutStatuses:
          $ref: '#/components/schemas/AccuracyOverTimePlotsStatus'
        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: 0
          maximum: 1
          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
    AnyCellSchema:
      description: The schema for cells in a notebook that are not code or markdown.
      properties:
        cellType:
          description: Type of the cell.
          title: Celltype
          type: string
        id:
          description: ID of the cell.
          title: Id
          type: string
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: Metadata of the cell.
          title: Metadata
        source:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          default: ''
          description: Contents of the cell, represented as a string.
          title: Source
      required:
      - id
      - cellType
      title: AnyCellSchema
      type: object
    Application:
      properties:
        applicationTemplateType:
          description: Application template type, purpose
          type:
          - string
          - 'null'
        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
          - 'null'
        creatorFirstName:
          description: Application creator first name
          type:
          - string
          - 'null'
        creatorLastName:
          description: Application creator last name
          type:
          - string
          - 'null'
        creatorUserhash:
          description: Application creator userhash
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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'
          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
          type:
          - string
          - 'null'
        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
        realtimePredictionsSupport:
          description: Sets whether you can do realtime predictions in the app.
          type: boolean
          x-versionadded: v2.34
        relatedEntities:
          $ref: '#/components/schemas/ApplicationRelatedEntities'
        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
      - hasCustomLogo
      - id
      - modelDeploymentId
      - name
      - orgId
      - permissions
      - poolUsed
      - realtimePredictionsSupport
      - 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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - 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
          type:
          - string
          - 'null'
        cloudProvider:
          default: drcloud
          description: The optional cloud provider
          enum:
          - drcloud
          - heroku
          type: string
        description:
          description: The description of the application
          maxLength: 512
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        description:
          description: The description of the application
          maxLength: 512
          type:
          - string
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - 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
          type:
          - string
          - 'null'
        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:
      description: IDs of entities, related to app for easy search
      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
          type:
          - string
          - 'null'
        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
          - 'null'
        creatorFirstName:
          description: Application creator first name
          type:
          - string
          - 'null'
        creatorLastName:
          description: Application creator last name
          type:
          - string
          - 'null'
        creatorUserhash:
          description: Application creator userhash
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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'
          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.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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
        realtimePredictionsSupport:
          description: Sets whether you can do realtime predictions in the app.
          type: boolean
          x-versionadded: v2.34
        relatedEntities:
          $ref: '#/components/schemas/ApplicationRelatedEntities'
        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
      - hasCustomLogo
      - id
      - name
      - orgId
      - permissions
      - poolUsed
      - realtimePredictionsSupport
      - updatedAt
      - userId
      type: object
    ApplicationSharedRolesEntry:
      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
          - 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 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
      required:
      - id
      - role
      - shareRecipientType
      type: object
    ApplicationSharedRolesList:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: Number of items matching to the query condition
          type: integer
      required:
      - 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
    ApplicationTemplateCloneResponse:
      properties:
        notebookId:
          description: The ID of the newly created codespace.
          type: string
        useCaseId:
          description: The ID of the newly created Use Case.
          type: string
      required:
      - notebookId
      - useCaseId
      type: object
      x-versionadded: v2.35
    ApplicationTemplateCreate:
      properties:
        description:
          description: The short description of the template.
          type: string
        media:
          description: The image (.png, .jpg, .svg, .gif) that is displayed alongside
            the template.
          format: binary
          type: string
        name:
          description: The name of the template.
          maxLength: 256
          type: string
        ports:
          description: A list of ports that the application template exposes. Each
            port has a port number and an optional description.
          type: string
          x-versionadded: v2.38
        readme:
          description: A long-form Markdown readme to be included with the template.
          format: binary
          type: string
        repository:
          description: The repository the template is stored in.
          type: string
        tags:
          description: All tags of the repository.
          maxLength: 256
          type: string
      required:
      - description
      - name
      - readme
      - repository
      - tags
      type: object
      x-versionadded: v2.35
    ApplicationTemplateListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of templates.
          items:
            $ref: '#/components/schemas/ApplicationTemplateResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    ApplicationTemplateMediaResponse:
      properties:
        data:
          description: The media file returned as a FileObject.
          format: binary
          type: string
      required:
      - data
      type: object
      x-versionadded: v2.35
    ApplicationTemplateMediaUpload:
      properties:
        media:
          description: The image (.png, .jpg, .svg, .gif) that is displayed alongside
            the template.
          format: binary
          type: string
      required:
      - media
      type: object
      x-versionadded: v2.35
    ApplicationTemplateRepositoryUrlResponse:
      properties:
        repositoryUrl:
          description: The resolved clone URL for the template repository with any
            configured git base URL override applied.
          format: uri
          type: string
      required:
      - repositoryUrl
      type: object
      x-versionadded: v2.43
    ApplicationTemplateResponse:
      properties:
        createdAt:
          description: The ISO timestamp indicating when the template was created.
          type:
          - string
          - 'null'
        createdBy:
          description: The user who created the template.
          type:
          - string
          - 'null'
        creatorFirstName:
          description: The first name of the user who created the template.
          type:
          - string
          - 'null'
        creatorLastName:
          description: The last name of the user who created the template.
          type:
          - string
          - 'null'
        creatorUserhash:
          description: The Gravatar hash of the user who created the template.
          type:
          - string
          - 'null'
        description:
          description: The short description of the template.
          type: string
        editedAt:
          description: The ISO timestamp indicating when the template was last edited.
          type:
          - string
          - 'null'
        editedBy:
          description: The user who last edited the template.
          type:
          - string
          - 'null'
        editorFirstName:
          description: The first name of the user who last edited the template.
          type:
          - string
          - 'null'
        editorLastName:
          description: The last name of the user who last edited the template.
          type:
          - string
          - 'null'
        editorUserhash:
          description: The Gravatar hash of the user who last edited the template.
          type:
          - string
          - 'null'
        id:
          description: The ID of the template.
          type: string
        isGlobal:
          description: Whether the template is a global template created by DataRobot.
          type: boolean
        isPremium:
          description: Whether the template is a premium template.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.36
        mediaUrl:
          description: The link to the media URL if there is media associated with
            the application.
          format: uri
          type:
          - string
          - 'null'
        name:
          description: The name of the template.
          maxLength: 256
          type: string
        orderIndex:
          description: The order index of the template.
          type:
          - integer
          - 'null'
          x-versionadded: v2.39
        ports:
          description: A list of ports that the application template exposes. Each
            port has a port number and an optional description.
          items:
            $ref: '#/components/schemas/Ports'
          maxItems: 5
          type: array
          x-versionadded: v2.38
        readme:
          description: A long-form Markdown readme to be included with the template.
          maxLength: 256000
          type: string
        repository:
          $ref: '#/components/schemas/Repository'
        tags:
          description: All tags of the repository.
          items:
            description: A single tag on the repository such as GenAI or Time Series.
            maxLength: 256
            type: string
          maxItems: 256
          type: array
      required:
      - createdAt
      - createdBy
      - description
      - editedAt
      - editedBy
      - editorFirstName
      - editorLastName
      - editorUserhash
      - id
      - isGlobal
      - isPremium
      - mediaUrl
      - name
      - orderIndex
      - readme
      - repository
      - tags
      type: object
      x-versionadded: v2.35
    ApplicationTemplateUpdate:
      properties:
        description:
          description: The short description of the template.
          type: string
        name:
          description: The name of the template.
          maxLength: 256
          type: string
        ports:
          description: A list of ports that the application template exposes. Each
            port has a port number and an optional description.
          type: string
          x-versionadded: v2.38
        readme:
          description: A long-form Markdown readme to be included with the template.
          format: binary
          type: string
        repository:
          description: The repository the template is stored in.
          type: string
        tags:
          description: All tags of the repository.
          maxLength: 256
          type: string
      type: object
      x-versionadded: v2.35
    ApplicationUserRoleResponse:
      properties:
        role:
          description: The role of the user on this entity.
          type: string
      required:
      - role
      type: object
    ApplyEntitlementSetLeaseRequest:
      properties:
        acceptedTerms:
          description: Indicates the requesting user has actively accepted the required
            terms and conditions for starting the trial.
          type: boolean
        durationDays:
          description: Duration of the lease in days.
          minimum: 1
          type: integer
        entitlementSetId:
          description: UUID of the entitlement set to lease.
          type: string
        tenantId:
          description: UUID of the tenant to apply entitlements to.
          type: string
      required:
      - acceptedTerms
      - durationDays
      - entitlementSetId
      type: object
      x-versionadded: v2.38
    ApprovalPolicy:
      properties:
        active:
          default: true
          description: Whether this policy is active.
          type: boolean
        automaticAction:
          $ref: '#/components/schemas/ApprovalPolicyAutomaticAction'
        name:
          description: Name of the Approval Policy.
          maxLength: 50
          type: string
        review:
          $ref: '#/components/schemas/ApprovalPolicyReview'
        trigger:
          $ref: '#/components/schemas/ApprovalPolicyTrigger'
      required:
      - active
      - name
      - trigger
      type: object
    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.
      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:
      description: An object, describing the approvals workflow intended action.
      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'
      required:
      - action
      type: object
    ApprovalPolicyIntendedActionCondition:
      description: An object, describing the condition to trigger on.
      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
          type: array
      required:
      - condition
      - fieldName
      - values
      type: object
    ApprovalPolicyListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of Approval Policies.
          items:
            $ref: '#/components/schemas/ApprovalPolicyResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        fieldValue:
          description: Value of the entity field to filter policies by.
          maxLength: 50
          type:
          - string
          - 'null'
        policyId:
          description: ID of the matching approval policy. ``null`` if no matching
            policies found.
          type:
          - string
          - 'null'
      required:
      - action
      - entityType
      - policyId
      type: object
    ApprovalPolicyResponse:
      properties:
        active:
          default: true
          description: Whether this policy is active.
          type: boolean
        automaticAction:
          $ref: '#/components/schemas/ApprovalPolicyAutomaticAction'
        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'
        trigger:
          $ref: '#/components/schemas/ApprovalPolicyTrigger'
      required:
      - active
      - id
      - name
      - openRequests
      - trigger
      type: object
    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.
      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
          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
          type:
          - string
          - 'null'
      type: object
    ApprovalPolicyTrigger:
      description: An object describing the trigger for the Approval Policy.
      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
          type: array
        intendedAction:
          $ref: '#/components/schemas/ApprovalPolicyIntendedAction'
        labels:
          $ref: '#/components/schemas/ApprovalPolicyTriggerLabel'
      required:
      - entityType
      - intendedAction
      type: object
    ApprovalPolicyTriggerLabel:
      description: Trigger Labels.
      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
    ArgumentMatchMode:
      description: The different modes for comparing the arguments of tool calls.
      enum:
      - exact_match
      - ignore_arguments
      title: ArgumentMatchMode
      type: string
    ArtifactCloneRequest:
      additionalProperties: false
      properties:
        name:
          description: The name of the cloned artifact.
          maxLength: 5000
          minLength: 1
          title: Name
          type: string
      required:
      - name
      title: ArtifactCloneRequest
      type: object
    ArtifactFormatted:
      additionalProperties: false
      properties:
        artifactRepositoryId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the artifact repository this artifact belongs to (for
            versioning support)
          title: Artifact Repository ID
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Created At
          type: string
        creator:
          anyOf:
          - $ref: '#/components/schemas/UserData'
          - type: 'null'
          description: Owner user details including ID, username and email
          title: Creator
        description:
          default: ''
          description: Description of the artifact
          title: Description
          type: string
        id:
          description: Unique identifier of the entity
          title: ID
          type: string
        name:
          description: Name of the entity
          title: Name
          type: string
        permissions:
          $ref: '#/components/schemas/ResourcePermissions'
          description: User permissions for this artifact
          title: Permissions
        spec:
          description: Artifact specification
          discriminator:
            mapping:
              nim: '#/components/schemas/NimArtifactSpec'
              service: '#/components/schemas/ServiceArtifactSpec'
            propertyName: type
          oneOf:
          - $ref: '#/components/schemas/ServiceArtifactSpec'
          - $ref: '#/components/schemas/NimArtifactSpec'
          title: Spec
        status:
          $ref: '#/components/schemas/ArtifactStatus'
          default: draft
          description: Artifact status
          title: Status
        tags:
          $ref: '#/components/schemas/Tags'
          description: Tags associated with this artifact
          title: Tags
        type:
          $ref: '#/components/schemas/ArtifactType'
          default: service
          description: Artifact type
          title: Type
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updated At
          type: string
        version:
          anyOf:
          - type: integer
          - type: 'null'
          description: Version number of the artifact (set only for locked artifacts)
          title: Version
      required:
      - id
      - name
      - createdAt
      - updatedAt
      - spec
      - artifactRepositoryId
      title: ArtifactFormatted
      type: object
    ArtifactInfoFormatted:
      description: Artifact basic information.
      properties:
        artifactRepositoryId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the artifact repository this artifact belongs to (for
            versioning)
          title: Artifactrepositoryid
        id:
          description: Unique identifier of the entity
          title: Id
          type: string
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the entity
          title: Name
        status:
          anyOf:
          - $ref: '#/components/schemas/ArtifactStatus'
          - type: 'null'
          description: Artifact status
        templateId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the template used to create this artifact
          title: Templateid
        type:
          anyOf:
          - $ref: '#/components/schemas/ArtifactType'
          - type: 'null'
          description: Artifact type
        version:
          anyOf:
          - type: integer
          - type: 'null'
          description: Version number of the artifact (set only for locked artifacts)
          title: Version
      required:
      - id
      title: ArtifactInfoFormatted
      type: object
    ArtifactListResponse:
      additionalProperties: false
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ArtifactFormatted'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ArtifactListResponse
      type: object
    ArtifactRepositoryFormatted:
      additionalProperties: false
      properties:
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Created At
          type: string
        creator:
          anyOf:
          - $ref: '#/components/schemas/UserData'
          - type: 'null'
          description: Owner user details including ID, username and email
          title: Creator
        id:
          description: Unique identifier of the entity
          title: ID
          type: string
        lastVersionNumber:
          default: 0
          description: Last version number
          title: Lastversionnumber
          type: integer
        name:
          description: Name of the entity
          title: Name
          type: string
        numArtifacts:
          default: 0
          description: Number of artifacts in this repository
          minimum: 0.0
          title: Numartifacts
          type: integer
        permissions:
          $ref: '#/components/schemas/ResourcePermissions'
          description: User permissions for this artifact repository
        tags:
          $ref: '#/components/schemas/Tags'
          description: Tags for this repository
        type:
          $ref: '#/components/schemas/ArtifactType'
          default: service
          description: Repository type (inherited from the first originating artifact)
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updated At
          type: string
      required:
      - id
      - name
      - createdAt
      - updatedAt
      title: ArtifactRepositoryFormatted
      type: object
    ArtifactRepositoryListResponse:
      additionalProperties: false
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ArtifactRepositoryFormatted'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ArtifactRepositoryListResponse
      type: object
    ArtifactSortQueryParams:
      anyOf:
      - $ref: '#/components/schemas/CommonSortQueryParams'
      - const: status
        description: Sort by status in ascending order (e.g., STOPPED before RUNNING)
        title: Status Ascending
        type: string
      - const: -status
        description: Sort by status in descending order (e.g., RUNNING before STOPPED)
        title: Status Descending
        type: string
    ArtifactStatus:
      enum:
      - draft
      - locked
      title: ArtifactStatus
      type: string
    ArtifactType:
      description: 'Discriminator for the artifact spec variant. Used to label the
        workload, which may be used

        to prioritize the best matching operator available in the cluster for scheduling.

        Defaults to ``service`` when omitted.

        - ``service``: generic service artifact.

        - ``nim``: NVIDIA NIM model artifact.'
      enum:
      - service
      - nim
      title: ArtifactType
      type: string
    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'
        enrichmentRateValue:
          description: Percentage of primary table records that can be enriched with
            a record in this dataset
          type: number
        featureDerivationWindow:
          description: Feature derivation window.
          type:
          - string
          - 'null'
        mostRecentData:
          $ref: '#/components/schemas/Warnings'
        overallCategory:
          description: Class of the relationship quality
          enum:
          - green
          - yellow
          type: string
        windowSettings:
          $ref: '#/components/schemas/Warnings'
      required:
      - enrichmentRate
      - enrichmentRateValue
      - overallCategory
      type: object
    AssignNotebookKernelRequest:
      description: Request payload values for assigning a kernel to a notebook.
      properties:
        kernelId:
          description: ID of the kernel to assign to the notebook.
          title: Kernelid
          type: string
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      title: AssignNotebookKernelRequest
      type: object
    AssociationID:
      description: The association ID setting for the deployment.
      properties:
        columnNames:
          description: List of column names used to represent an association ID.
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        requiredInPredictionRequests:
          description: Indicates whether the association ID is required in prediction
            requests.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
    AssociationIdField:
      description: A custom metric associationId source when reading values from columnar
        dataset like a file.
      properties:
        columnName:
          description: Column name
          type:
          - string
          - 'null'
      required:
      - columnName
      type: object
      x-versionadded: v2.36
    AuditLogContextObjectResponse:
      description: An object with additional attributes for the record.
      properties:
        orgId:
          description: The ID of the organization.
          type:
          - string
          - 'null'
        orgName:
          description: The name of the organization.
          type:
          - string
          - 'null'
        projectName:
          description: The name of the project.
          type:
          - string
          - 'null'
        projectType:
          description: The type of the project.
          type:
          - string
          - 'null'
        userProjectRole:
          description: The role of the user associated with this project.
          type:
          - string
          - 'null'
      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'
        event:
          description: The record event label (e.g., 'Start Autopilot').
          type: string
        id:
          description: The record ID.
          type:
          - string
          - 'null'
        ip:
          description: The IP address of the server where the record event happened.
            Will be empty if ``includeIdentifyingFields`` is True.
          type:
          - string
          - 'null'
        projectId:
          description: The record event project ID.
          type:
          - string
          - 'null'
        timestamp:
          description: The record timestamp.
          format: date-time
          type: string
        userId:
          description: The user ID of the user who triggered the record event.
          type: string
        username:
          description: The username of the record events user. Will be empty if ``includeIdentifyingFields``
            is True.
          type:
          - string
          - 'null'
      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
          type:
          - string
          - 'null'
        previous:
          description: A URL to the previous page (if null, no previous page exists).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The number of items matching the query condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    AuthorizationCodeOAuthFlow:
      description: Configuration for the OAuth 2.0 Authorization Code flow.
      properties:
        authorizationUrl:
          description: The authorization URL for the authorization code flow.
          type: string
        refreshUrl:
          description: The URL for refreshing tokens.
          type:
          - string
          - 'null'
        scopes:
          additionalProperties:
            type: string
          description: Available scopes mapping scope name to description.
          type: object
        tokenUrl:
          description: The token URL for exchanging the authorization code.
          type: string
      required:
      - authorizationUrl
      - scopes
      - tokenUrl
      type: object
      x-versionadded: v2.46
    AutomatedDocCreate:
      properties:
        documentType:
          description: Type of the automated document you want to generate.
          enum:
          - AUTOPILOT_SUMMARY
          - MODEL_COMPLIANCE
          - DEPLOYMENT_REPORT
          - MODEL_COMPLIANCE_GEN_AI
          type: string
          x-enum-versionadded:
          - value: DEPLOYMENT_REPORT
            x-versionadded: v2.24
          - value: MODEL_COMPLIANCE_GEN_AI
            x-versionadded: v2.35
        documentTypeSpecificParameters:
          description: 'Set parameters unique for a specific document type. Currently,
            only these document types can have document-specific parameters: [''DEPLOYMENT_REPORT'']'
          oneOf:
          - $ref: '#/components/schemas/AutomatedDocCreateDeploymentReport'
          - $ref: '#/components/schemas/AutomatedDocCreateModelComplianceDocs'
          - type: 'null'
          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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      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
          - MODEL_COMPLIANCE_GEN_AI
          type: string
          x-enum-versionadded:
          - value: DEPLOYMENT_REPORT
            x-versionadded: v2.24
          - value: MODEL_COMPLIANCE_GEN_AI
            x-versionadded: v2.35
        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: The number of items returned on this page.
          type: integer
        data:
          description: List of generated documents.
          items:
            $ref: '#/components/schemas/AutomatedDocItem'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          - MODEL_COMPLIANCE_GEN_AI
          type: string
          x-enum-versionadded:
          - value: DEPLOYMENT_REPORT
            x-versionadded: v2.24
          - value: MODEL_COMPLIANCE_GEN_AI
            x-versionadded: v2.35
        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
    AutomaticActuals:
      description: Automatic actuals setting for the deployment.
      properties:
        enabled:
          description: Indicates whether automatic actuals is enabled for the deployment.
          type: boolean
      required:
      - enabled
      type: object
      x-versionadded: v2.25
    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:
      description: Options for projects used to build new models.
      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
          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
    AutoscalingPolicy:
      additionalProperties: false
      description: Base class for autoscaling policies.
      properties:
        maxCount:
          description: Maximum number of replicas
          minimum: 0.0
          title: Max Count
          type: integer
        minCount:
          description: Minimum number of replicas
          minimum: 0.0
          title: Min Count
          type: integer
        priority:
          anyOf:
          - type: integer
          - type: 'null'
          description: Policy priority when multiple policies are defined
          title: Priority
        scalingMetric:
          anyOf:
          - $ref: '#/components/schemas/ScalingMetricType'
          - type: string
          description: Metric used for scaling decisions. Use one of the predefined
            values for standard autoscaling, or provide a custom metric name for NIM
            2.0 workloads (e.g. 'vllm:kv_cache_usage_perc'). Custom metric names are
            only supported for NIM artifacts.
          title: Scaling Metric
        target:
          description: Target value for the scaling metric
          minimum: 0.0
          title: Target
          type: number
      required:
      - scalingMetric
      - target
      - minCount
      - maxCount
      title: AutoscalingPolicy
      type: object
    AutoscalingProperties:
      additionalProperties: false
      description: Autoscaling configuration for a proton.
      properties:
        enabled:
          default: true
          description: Whether autoscaling is enabled
          title: Enabled
          type: boolean
        policies:
          items:
            $ref: '#/components/schemas/AutoscalingPolicy'
          title: Policies
          type: array
      required:
      - policies
      title: AutoscalingProperties
      type: object
    AvailableLiteLLMEndpoints:
      description: The supported endpoints for the LLM.
      properties:
        supportsChatCompletions:
          description: Whether the chat completions endpoint is supported.
          title: supportsChatCompletions
          type: boolean
        supportsResponses:
          description: Whether the responses endpoint is supported.
          title: supportsResponses
          type: boolean
      required:
      - supportsChatCompletions
      - supportsResponses
      title: AvailableLiteLLMEndpoints
      type: object
    AverageModelMetricsField:
      description: All average model metrics from one data source.
      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
    AwaitingInputState:
      description: AwaitingInputState represents the state of a cell that is awaiting
        input from the user.
      properties:
        password:
          description: Whether the input request is for a password.
          title: Password
          type: boolean
        prompt:
          description: The prompt for the input request.
          title: Prompt
          type: string
        requestedAt:
          description: The time the input was requested.
          format: date-time
          title: Requestedat
          type: string
      required:
      - requestedAt
      - prompt
      - password
      title: AwaitingInputState
      type: object
    AzureConnectionStringCredentialsFields:
      properties:
        azureConnectionString:
          description: The Azure connection string.
          type: string
          x-versionadded: v2.21
        credentialType:
          description: The type of these credentials, 'azure' here.
          enum:
          - azure
          type: string
      required:
      - azureConnectionString
      - credentialType
      type: object
      x-versionadded: v2.46
    AzureDataStreamer:
      description: Stream CSV data chunks from Azure
      properties:
        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
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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:
      description: Stream CSV data chunks from Azure
      properties:
        credentialId:
          description: Use the specified credential to access the url
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks to Azure Blob Storage
      properties:
        credentialId:
          description: Use the specified credential to access the url
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks to Azure Blob Storage
      properties:
        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
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
    AzureSasCredentialsFields:
      properties:
        credentialType:
          description: The type of these credentials, 'azure_sas' here.
          enum:
          - azure_sas
          type: string
        sasToken:
          description: The Azure shared access signature (SAS) token for Data Lake
            Storage Gen2.
          minLength: 1
          type: string
      required:
      - credentialType
      - sasToken
      type: object
      x-versionadded: v2.46
    AzureServicePrincipalCredentialsFields:
      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
        configId:
          description: The ID of the secure configuration to share Azure service principal
            credentials by admin.
          type: string
          x-versionadded: v2.35
        credentialType:
          description: The type of these credentials, 'azure_service_principal' here.
          enum:
          - azure_service_principal
          type: string
      required:
      - credentialType
      type: object
      x-versionadded: v2.46
    BOXJWTCredentialsFields:
      properties:
        clientId:
          description: Box JWT client ID.
          type: string
          x-versionadded: v2.41
        clientSecret:
          description: Box JWT client secret.
          type: string
          x-versionadded: v2.41
        configId:
          description: ID of secure configuration to share Box JWT credentials by
            admin.
          type: string
          x-versionadded: v2.41
        credentialType:
          description: The credential type.
          enum:
          - box_jwt
          type: string
          x-versionadded: v2.41
        enterpriseId:
          description: Box enterprise identifier.
          type: string
          x-versionadded: v2.41
        passphrase:
          description: Passphrase for the Box JWT private key.
          minLength: 1
          type: string
          x-versionadded: v2.41
        privateKeyStr:
          description: RSA private key for Box JWT.
          minLength: 1
          type: string
          x-versionadded: v2.41
        publicKeyId:
          description: Box public key identifier.
          type: string
          x-versionadded: v2.41
      required:
      - credentialType
      type: object
      x-versionadded: v2.42
    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:
      description: Method 2 - directly configure the start and end dates of each partition,
        including the training partition.
      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:
      description: Method 1 - pass validation and gap durations
      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
          type:
          - integer
          - 'null'
        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).
          type:
          - number
          - 'null'
        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
          type:
          - number
          - 'null'
        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
    BaseCategoricalStatsArguments:
      description: Task arguments.
      properties:
        methods:
          description: 'Window method: most-frequent'
          items:
            enum:
            - most-frequent
            type: string
          maxItems: 10
          minItems: 1
          type: array
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
        windowSize:
          description: Rolling window size, defined in terms of rows. Left end is
            exclusive, right end is inclusive.
          exclusiveMinimum: 0
          maximum: 300
          type: integer
      required:
      - methods
      - skip
      - windowSize
      type: object
      x-versionadded: v2.35
    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.
      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.
          type:
          - string
          - 'null'
        buildLogLocation:
          description: The URL to download the build logs from this build.
          format: uri
          type:
          - string
          - 'null'
        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
          - aborted
          type: string
      required:
      - buildEnd
      - buildLogLocation
      - buildStart
      - buildStatus
      type: object
    BaseDirectiveArguments:
      description: The transformation description.
      properties:
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
      required:
      - skip
      type: object
      x-versionadded: v2.37
    BaseFilesVersionResponse:
      properties:
        catalogId:
          description: The ID of the catalog entry.
          type: string
        catalogVersionId:
          description: The ID of the catalog entry version.
          type: string
      required:
      - catalogId
      - catalogVersionId
      type: object
      x-versionadded: v2.42
    BaseLagsArguments:
      description: Task arguments.
      properties:
        orders:
          description: Lag orders.
          items:
            exclusiveMinimum: 0
            maximum: 300
            type: integer
          maxItems: 100
          minItems: 1
          type: array
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - orders
      - skip
      type: object
      x-versionadded: v2.35
    BaseNumericStatsArguments:
      description: Task arguments.
      properties:
        methods:
          description: Methods to apply in a rolling window.
          items:
            enum:
            - avg
            - max
            - median
            - min
            - stddev
            type: string
          maxItems: 10
          minItems: 1
          type: array
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
        windowSize:
          description: Rolling window size, defined in terms of rows. Left end is
            exclusive, right end is inclusive.
          exclusiveMinimum: 0
          maximum: 300
          type: integer
      required:
      - methods
      - skip
      - windowSize
      type: object
      x-versionadded: v2.35
    BasicCredentialsFields:
      properties:
        credentialType:
          description: The type of these credentials, 'basic' here.
          enum:
          - basic
          type: string
        password:
          description: Password to store for these credentials.
          type: string
        user:
          description: Username to store for these credentials.
          type: string
      required:
      - credentialType
      - password
      - user
      type: object
      x-versionadded: v2.46
    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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          type: array
        createdBy:
          description: Username of the user who created the dataset.
          type:
          - string
          - 'null'
        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'
          x-versionadded: v2.27
        timeSeriesProperties:
          $ref: '#/components/schemas/TimeSeriesProperties'
          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
            - SAMPLE
            - 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.
          type:
          - string
          - 'null'
        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'
          x-versionadded: v2.27
        timeSeriesProperties:
          $ref: '#/components/schemas/TimeSeriesProperties'
          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:
      description: Batch info.
      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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        name:
          description: Batch name.
          type: string
          x-versionadded: v2.33
      required:
      - earliestPredictionTimestamp
      - id
      - latestPredictionTimestamp
      - name
      type: object
    BatchCellQuery:
      description: Base schema for batch cell queries.
      properties:
        actionId:
          description: Action ID of the notebook update request.
          maxLength: 64
          title: Actionid
          type: string
        cellIds:
          description: List of cell IDs to operate on.
          items:
            type: string
          title: Cellids
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - generation
      - path
      - cellIds
      title: BatchCellQuery
      type: object
    BatchClearCellsOutputRequest:
      description: Request schema for batch clearing the output of notebook cells.
      properties:
        cellIds:
          description: The IDs of the cells to clear the output of.
          items:
            type: string
          title: Cellids
          type: array
      required:
      - cellIds
      title: BatchClearCellsOutputRequest
      type: object
    BatchCreateCellsRequest:
      description: Request schema for batch creating notebook cells.
      properties:
        afterCellId:
          anyOf:
          - type: string
          - enum:
            - FIRST
            type: string
          description: The ID of the cell after which to create the new cells.
          title: Aftercellid
        cells:
          description: The list of cells to create.
          items:
            $ref: '#/components/schemas/NotebookCellSourceMetadata'
          title: Cells
          type: array
      required:
      - afterCellId
      title: BatchCreateCellsRequest
      type: object
    BatchCreateEventRequest:
      description: Schema for batch event creation. Events are appended in list order.
      properties:
        events:
          description: Events to append, in order.
          items:
            $ref: '#/components/schemas/CreateEventRequest'
          maxItems: 200
          minItems: 1
          title: Events
          type: array
      required:
      - events
      title: BatchCreateEventRequest
      type: object
    BatchDeleteCellsRequest:
      description: Request schema for batch deleting notebook cells.
      properties:
        cellIds:
          description: The IDs of the cells to delete.
          items:
            type: string
          title: Cellids
          type: array
      required:
      - cellIds
      title: BatchDeleteCellsRequest
      type: object
    BatchEventResponse:
      description: 'Envelope wrapping a list of event responses for batch endpoints.


        Per the DataRobot API design policy enforced by adipose, every JSON response
        must

        be an object. The single-event endpoints already satisfy this; the batch endpoints

        wrap their list in this envelope so the same rule holds.'
      properties:
        items:
          description: Events processed by the batch operation.
          items:
            $ref: '#/components/schemas/EventResponse'
          maxItems: 200
          title: Items
          type: array
      required:
      - items
      title: BatchEventResponse
      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:
      description: A custom metric batch ID source when reading values from columnar
        dataset like a file.
      properties:
        columnName:
          description: Column name
          type:
          - string
          - 'null'
      required:
      - columnName
      type: object
    BatchJobCSVSettings:
      description: The CSV settings used for this job
      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:
      description: Who created this job
      properties:
        fullName:
          description: The full name of the user who created this job (if defined
            by the user)
          type:
          - string
          - 'null'
        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
    BatchJobDefinitionResponse:
      description: The Batch Prediction Job Definition linking to this job, if any.
      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
      x-versionadded: v2.35
    BatchJobDefinitionsSpecResponse:
      description: The Batch Monitoring Job specification to be put on the queue in
        intervals
      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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/DataStageDataStreamer'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/CatalogDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/GCPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3DataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/DSSDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HTTPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileDataStreamer'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksDataStreamer'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereDataStreamer'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoDataStreamer'
            x-versionadded: v2.41
        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)
          oneOf:
          - minimum: 0
            type: integer
          - enum:
            - all
            type: string
          - type: 'null'
          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'
          x-versionadded: v2.30
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          type:
          - string
          - 'null'
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
          x-versionadded: v2.30
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
        numConcurrent:
          default: 0
          description: Number of simultaneous requests to run against the prediction
            instance
          minimum: 0
          type: integer
        outputSettings:
          description: The response option configured for this job
          oneOf:
          - $ref: '#/components/schemas/AzureOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/GCPOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3OutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/FileSystemOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HttpOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JdbcOutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutputAdaptor'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksOutputAdaptor'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutputAdaptor'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoOutputAdaptor'
            x-versionadded: v2.41
          - type: 'null'
        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'
        predictionWarningEnabled:
          description: Enable prediction warnings.
          type:
          - boolean
          - 'null'
        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/BatchJobTimeSeriesSettingsHistorical'
          x-versionadded: v2.30
      required:
      - abortOnError
      - csvSettings
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - redactedFields
      - skipDriftTracking
      type: object
      x-versionadded: v2.35
    BatchJobLinks:
      description: Links useful for this job
      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.
          type:
          - string
          - 'null'
        self:
          description: The URL used access this job.
          format: url
          type: string
      required:
      - self
      type: object
      x-versionadded: v2.35
    BatchJobListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array of jobs
          items:
            $ref: '#/components/schemas/BatchJobResponse'
          maxItems: 10000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    BatchJobPredictionInstance:
      description: Override the default prediction instance from the deployment when
        scoring this job.
      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)
          type:
          - string
          - 'null'
      required:
      - inputName
      - outputName
      type: object
    BatchJobResponse:
      properties:
        batchMonitoringJobDefinition:
          $ref: '#/components/schemas/BatchJobDefinitionResponse'
          x-versionadded: v2.30
        batchPredictionJobDefinition:
          $ref: '#/components/schemas/BatchJobDefinitionResponse'
          x-versionadded: v2.30
        created:
          description: When was this job created
          format: date-time
          type: string
          x-versionadded: v2.30
        createdBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
          x-versionadded: v2.30
        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.30
        id:
          description: The ID of the Batch job
          type: string
          x-versionadded: v2.30
        intakeDatasetDisplayName:
          description: If applicable (e.g. for AI catalog), will contain the dataset
            name used for the intake dataset.
          type:
          - string
          - 'null'
          x-versionadded: v2.30
        jobIntakeSize:
          description: Number of bytes in the intake dataset for this job
          minimum: 0
          type:
          - integer
          - 'null'
        jobOutputSize:
          description: Number of bytes in the output dataset for this job
          minimum: 0
          type:
          - integer
          - 'null'
        jobSpec:
          $ref: '#/components/schemas/BatchJobSpecResponse'
        links:
          $ref: '#/components/schemas/BatchJobLinks'
        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.
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.30
        queued:
          description: The job has been put on the queue for execution.
          type: boolean
          x-versionadded: v2.30
        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.30
        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.30
        source:
          description: Source from which batch job was started
          type: string
          x-versionadded: v2.30
        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
      x-versionadded: v2.35
    BatchJobSpecResponse:
      description: The job configuration used to create this job
      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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/DataStageDataStreamer'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/CatalogDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/GCPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3DataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/DSSDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HTTPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileDataStreamer'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksDataStreamer'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereDataStreamer'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoDataStreamer'
            x-versionadded: v2.41
        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)
          oneOf:
          - minimum: 0
            type: integer
          - enum:
            - all
            type: string
          - type: 'null'
          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'
          x-versionadded: v2.30
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          type:
          - string
          - 'null'
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
          x-versionadded: v2.30
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/GCPOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3OutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/FileSystemOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HttpOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JdbcOutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutputAdaptor'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksOutputAdaptor'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutputAdaptor'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoOutputAdaptor'
            x-versionadded: v2.41
          - type: 'null'
        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'
        predictionWarningEnabled:
          description: Enable prediction warnings.
          type:
          - boolean
          - 'null'
        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/BatchJobTimeSeriesSettingsHistorical'
          x-versionadded: v2.30
      required:
      - abortOnError
      - csvSettings
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - redactedFields
      - skipDriftTracking
      type: object
      x-versionadded: v2.35
    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
    BatchMonitoringJobCreate:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        batchJobType:
          default: monitoring
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/DatabricksIntake'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/Catalog'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DatasphereIntake'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/DSS'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoIntake'
            x-versionadded: v2.41
        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
        monitoringAggregation:
          $ref: '#/components/schemas/MonitoringAggregation'
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          type:
          - string
          - 'null'
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DatabricksOutput'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutput'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoOutput'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        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
      x-versionadded: v2.35
    BatchMonitoringJobDefinitionsCreate:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        batchJobType:
          default: monitoring
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        deploymentId:
          description: ID of deployment that the monitoring jobs is associated with.
          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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/DatabricksIntake'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/Catalog'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DatasphereIntake'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/DSS'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoIntake'
            x-versionadded: v2.41
        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
        monitoringAggregation:
          $ref: '#/components/schemas/MonitoringAggregation'
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          type:
          - string
          - 'null'
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DatabricksOutput'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutput'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoOutput'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        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
      - deploymentId
      - disableRowLevelErrorHandling
      - includePredictionStatus
      - includeProbabilities
      - includeProbabilitiesClasses
      - intakeSettings
      - maxExplanations
      - skipDriftTracking
      type: object
      x-versionadded: v2.35
    BatchMonitoringJobDefinitionsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array of scheduled jobs
          items:
            $ref: '#/components/schemas/BatchMonitoringJobDefinitionsResponse'
          maxItems: 10000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    BatchMonitoringJobDefinitionsResponse:
      properties:
        batchMonitoringJob:
          $ref: '#/components/schemas/BatchJobDefinitionsSpecResponse'
        created:
          description: When was this job created
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
        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
          type:
          - string
          - 'null'
        lastScheduledRunTime:
          description: Last time this job was scheduled to run (though not guaranteed
            it actually ran at that time)
          format: date-time
          type:
          - string
          - 'null'
        lastStartedJobStatus:
          description: The status of the latest job launched to the queue (if any).
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          type:
          - string
          - 'null'
        lastStartedJobTime:
          description: The last time (if any) a job was launched.
          format: date-time
          type:
          - string
          - 'null'
        lastSuccessfulRunTime:
          description: Last time this job had a successful run
          format: date-time
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        updated:
          description: When was this job last updated
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
      required:
      - batchMonitoringJob
      - created
      - createdBy
      - enabled
      - id
      - lastStartedJobStatus
      - lastStartedJobTime
      - name
      - updated
      - updatedBy
      type: object
      x-versionadded: v2.35
    BatchMonitoringJobDefinitionsUpdate:
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        batchJobType:
          default: prediction
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/DatabricksIntake'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/Catalog'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DatasphereIntake'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/DSS'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoIntake'
            x-versionadded: v2.41
        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
        monitoringAggregation:
          $ref: '#/components/schemas/MonitoringAggregation'
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          type:
          - string
          - 'null'
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DatabricksOutput'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutput'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoOutput'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        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
      type: object
      x-versionadded: v2.35
    BatchPeriod:
      description: Time period of the batch.
      properties:
        end:
          description: End time of the bucket
          format: date-time
          type:
          - string
          - 'null'
        start:
          description: Start time of the bucket
          format: date-time
          type:
          - string
          - 'null'
      required:
      - end
      - start
      type: object
    BatchPredictionCreatedBy:
      description: Who created this job
      properties:
        fullName:
          description: The full name of the user who created this job (if defined
            by the user)
          type:
          - string
          - 'null'
        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:
      description: The CSV settings used for this job
      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
        batchJobType:
          default: prediction
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
          x-versionadded: v2.35
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/DatabricksIntake'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/Catalog'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DatasphereIntake'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/DSS'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoIntake'
            x-versionadded: v2.41
        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
          type:
          - string
          - 'null'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DatabricksOutput'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutput'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoOutput'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        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:
      description: The Batch Prediction Job specification to be put on the queue in
        intervals
      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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/DataStageDataStreamer'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/CatalogDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/GCPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3DataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/DSSDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HTTPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileDataStreamer'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksDataStreamer'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereDataStreamer'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoDataStreamer'
            x-versionadded: v2.41
        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)
          oneOf:
          - minimum: 0
            type: integer
          - enum:
            - all
            type: string
          - type: 'null'
          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'
          x-versionadded: v2.30
        monitoringBatchPrefix:
          description: Name of the batch to create with this job
          type:
          - string
          - 'null'
        monitoringColumns:
          $ref: '#/components/schemas/MonitoringColumnsMapping'
          x-versionadded: v2.30
        monitoringOutputSettings:
          $ref: '#/components/schemas/MonitoringOutputSettings'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/GCPOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3OutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/FileSystemOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HttpOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JdbcOutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutputAdaptor'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksOutputAdaptor'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutputAdaptor'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoOutputAdaptor'
            x-versionadded: v2.41
          - type: 'null'
        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'
        predictionWarningEnabled:
          description: Enable prediction warnings.
          type:
          - boolean
          - 'null'
        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:
      description: The Batch Prediction Job Definition linking to this job, if any.
      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
        batchJobType:
          default: prediction
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
          x-versionadded: v2.35
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/DatabricksIntake'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/Catalog'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DatasphereIntake'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/DSS'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoIntake'
            x-versionadded: v2.41
        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
          type:
          - string
          - 'null'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DatabricksOutput'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutput'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoOutput'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        created:
          description: When was this job created
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
        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
          type:
          - string
          - 'null'
        lastScheduledRunTime:
          description: Last time this job was scheduled to run (though not guaranteed
            it actually ran at that time)
          format: date-time
          type:
          - string
          - 'null'
        lastStartedJobStatus:
          description: The status of the latest job launched to the queue (if any).
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          type:
          - string
          - 'null'
        lastStartedJobTime:
          description: The last time (if any) a job was launched.
          format: date-time
          type:
          - string
          - 'null'
        lastSuccessfulRunTime:
          description: Last time this job had a successful run
          format: date-time
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        updated:
          description: When was this job last updated
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/BatchJobCreatedBy'
      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
        batchJobType:
          default: prediction
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
          x-versionadded: v2.35
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DataStageIntake'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/DatabricksIntake'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/Catalog'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/DatasphereIntake'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/DSS'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemIntake'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPIntake'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCIntake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileIntake'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Intake'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseIntake'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoIntake'
            x-versionadded: v2.41
        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
          type:
          - string
          - 'null'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/DatabricksOutput'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutput'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/FileSystemOutput'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/GCPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/HTTPOutput'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCOutput'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutput'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/S3Output'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutput'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/TrinoOutput'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        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:
      description: Links useful for this job
      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.
          type:
          - string
          - 'null'
        self:
          description: The URL used access this job.
          format: url
          type: string
      required:
      - self
      type: object
    BatchPredictionJobListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array of jobs
          items:
            $ref: '#/components/schemas/BatchPredictionJobResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    BatchPredictionJobPredictionInstance:
      description: Override the default prediction instance from the deployment when
        scoring this job.
      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)
          type:
          - string
          - 'null'
      required:
      - inputName
      - outputName
      type: object
    BatchPredictionJobResponse:
      properties:
        batchPredictionJobDefinition:
          $ref: '#/components/schemas/BatchPredictionJobDefinitionResponse'
          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'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.23
        jobIntakeSize:
          description: Number of bytes in the intake dataset for this job
          minimum: 0
          type:
          - integer
          - 'null'
        jobOutputSize:
          description: Number of bytes in the output dataset for this job
          minimum: 0
          type:
          - integer
          - 'null'
        jobSpec:
          $ref: '#/components/schemas/BatchPredictionJobSpecResponse'
        links:
          $ref: '#/components/schemas/BatchPredictionJobLinks'
        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.
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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:
      description: The job configuration used to create this job
      properties:
        abortOnError:
          default: true
          description: Should this job abort if too many errors are encountered
          type: boolean
        batchJobType:
          default: prediction
          description: Batch job type.
          enum:
          - monitoring
          - prediction
          type: string
          x-versionadded: v2.35
        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
          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
          - type: 'null'
        csvSettings:
          $ref: '#/components/schemas/BatchPredictionJobCSVSettings'
          default:
            delimiter: ','
            encoding: utf-8
            quotechar: '"'
        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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            description: Class name to explain
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.29
        explanationNumTopClasses:
          description: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/DataStageDataStreamer'
            x-versionadded: v2.28
          - $ref: '#/components/schemas/CatalogDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/GCPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3DataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseDataStreamer'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/DSSDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/FileSystemDataStreamer'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HTTPDataStreamer'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JDBCDataStreamer'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileDataStreamer'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksDataStreamer'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereDataStreamer'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoDataStreamer'
            x-versionadded: v2.41
        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
          type:
          - string
          - 'null'
        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
          oneOf:
          - $ref: '#/components/schemas/AzureOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/GCPOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/BigQueryOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/S3OutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/SnowflakeOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/SynapseOutputAdaptor'
            x-versionadded: v2.25
          - $ref: '#/components/schemas/FileSystemOutputAdaptor'
            x-versionadded: v2.26
          - $ref: '#/components/schemas/HttpOutputAdaptor'
            x-versionadded: v2.21
          - $ref: '#/components/schemas/JdbcOutputAdaptor'
            x-versionadded: v2.20
          - $ref: '#/components/schemas/LocalFileOutputAdaptor'
            x-versionadded: v2.19
          - $ref: '#/components/schemas/DatabricksOutputAdaptor'
            x-versionadded: v2.42
          - $ref: '#/components/schemas/DatasphereOutputAdaptor'
            x-versionadded: v2.36
          - $ref: '#/components/schemas/TrinoOutputAdaptor'
            x-versionadded: v2.41
          - type: 'null'
        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'
        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.
          type:
          - boolean
          - 'null'
        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'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.26
        completed:
          description: Time when job completed scoring
          format: date-time
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.26
        jobOutputSize:
          description: Number of bytes in the output dataset for this job
          type:
          - integer
          - 'null'
          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
          type:
          - string
          - 'null'
          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:
      description: The batch prediction status for this instance.
      properties:
        processing:
          description: The number of jobs processing.
          minimum: 0
          type: integer
        queued:
          description: The number of jobs queued.
          minimum: 0
          type: integer
      required:
      - processing
      - queued
      type: object
    BatchUpdateCellsMetadataRequest:
      description: Request schema for batch updating notebook cells metadata.
      properties:
        cellIds:
          description: The IDs of the cells to update.
          items:
            type: string
          title: Cellids
          type: array
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: The metadata to update the cells with.
          title: Metadata
      required:
      - cellIds
      - metadata
      title: BatchUpdateCellsMetadataRequest
      type: object
    BatchUpdateCellsSourcesRequest:
      description: Request schema for batch updating notebook cells sources.
      properties:
        cells:
          description: The list of cells to update.
          items:
            $ref: '#/components/schemas/NotebookCellSource'
          title: Cells
          type: array
      title: BatchUpdateCellsSourcesRequest
      type: object
    BatchUpdateEventItem:
      description: 'A single item of a batch update: identifies the target event by
        sequence_id.


        Inherits the mutable body/type/emitter fields from UpdateEventRequest. The

        inherited "at least one field present" validator is overridden below because
        the

        always-present sequence_id would otherwise satisfy it vacuously.'
      properties:
        body:
          anyOf:
          - $ref: '#/components/schemas/EventBody'
          - type: 'null'
          description: Updated event body.
        createdAt:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: 'Optional per-item version check: must match the target event''s
            timestamp.'
          title: Createdat
        emitter:
          anyOf:
          - $ref: '#/components/schemas/EmitterDataModel'
          - type: 'null'
          description: Updated emitter information.
        sequenceId:
          description: Target event sequence ID within the session.
          minimum: 0.0
          title: Sequenceid
          type: integer
        type:
          anyOf:
          - $ref: '#/components/schemas/EventType'
          - type: 'null'
          description: Updated event type.
      required:
      - sequenceId
      title: BatchUpdateEventItem
      type: object
    BatchUpdateEventRequest:
      description: Schema for batch event update.
      properties:
        events:
          description: Events to update.
          items:
            $ref: '#/components/schemas/BatchUpdateEventItem'
          maxItems: 200
          minItems: 1
          title: Events
          type: array
      required:
      - events
      title: BatchUpdateEventRequest
      type: object
    BatchUserInviteResponse:
      properties:
        errors:
          description: List of errors encountered, if any.
          items:
            type: string
          maxItems: 20
          type: array
        message:
          description: Status message for the batch invite job.
          type: string
      required:
      - errors
      - message
      type: object
      x-versionadded: v2.46
    BiasAndFairness:
      description: Bias and fairness setting for the deployment.
      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 features 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
          type:
          - string
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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: 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
          type:
          - number
          - 'null'
        modelId:
          description: ID of the model.
          type: string
        modelNumber:
          description: The model number from the Leaderboard.
          exclusiveMinimum: 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:
      description: Stream CSV data chunks from Big Query using GCS
      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:
      description: Stream CSV data chunks from Big Query using GCS
      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:
      description: Save CSV data chunks to Google BigQuery in bulk
      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:
      description: Save CSV data chunks to Google BigQuery in bulk
      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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    BlenderRetrieveResponse:
      properties:
        blenderMethod:
          description: Method used to blend results of underlying models.
          type: string
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          type:
          - string
          - 'null'
          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.
          type: object
        modelCategory:
          description: Indicates the type 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 the 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: 0
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          type:
          - integer
          - 'null'
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          type:
          - string
          - 'null'
        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: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
        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: 100
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          type:
          - string
          - 'null'
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          type:
          - string
          - 'null'
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          type:
          - string
          - 'null'
      required:
      - blenderMethod
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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.
          type:
          - string
          - 'null'
      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.
          type:
          - string
          - 'null'
      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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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
    BooleanSettingConstraints:
      description: Available constraints for boolean settings.
      properties:
        type:
          const: boolean
          default: boolean
          description: The data type of the setting.
          title: type
          type: string
      title: BooleanSettingConstraints
      type: object
    BpData:
      properties:
        children:
          description: A nested dictionary representation of the blueprint DAG.
          items:
            $ref: '#/components/schemas/AllowExtra'
          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'
        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
      - tasks
      - type
      type: object
    BucketBatch:
      description: Describes a batch associated with the bucket.
      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:
        inputsAsAliases:
          default: false
          description: Produce the SQL that uses the input aliases instead of the
            real table names.
          type: boolean
          x-versionadded: v2.36
        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
          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 entity,
            grant the user read access to any linked objects such as `DataSources`
            and `DataStores` that may be used by this entity. Ignored if no such objects
            are relevant for the entity. This 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 the user making the call
            does not have sufficient permissions to complete the grant. Default value
            is false.
          type: boolean
        roles:
          description: An array of `RoleRequest` objects. Maximum number of such objects
            is 100.
          items:
            oneOf:
            - $ref: '#/components/schemas/CatalogRolesWithNames'
            - $ref: '#/components/schemas/CatalogRolesWithId'
          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
    BulkLinkNotebooksToUseCaseRequest:
      description: Request payload schema for bulk linking notebooks to a use case.
      properties:
        notebookIds:
          description: List of notebook IDs to link.
          items:
            type: string
          maxItems: 100
          minItems: 1
          title: Notebookids
          type: array
        source:
          allOf:
          - $ref: '#/components/schemas/EntityLinkingSources'
          description: The source of the entity linking.
        useCaseId:
          description: The ID of the Use Case to link the notebooks to.
          title: Usecaseid
          type: string
        workflow:
          allOf:
          - $ref: '#/components/schemas/EntityLinkingWorkflows'
          description: The workflow responsible for attaching the notebook to the
            Use Case.
      required:
      - notebookIds
      - useCaseId
      title: BulkLinkNotebooksToUseCaseRequest
      type: object
    BulkMetricInputValueBucket:
      properties:
        associationId:
          default: null
          description: Identifies prediction row corresponding to value.
          type:
          - string
          - 'null'
        customMetricId:
          description: ID of the custom metric.
          type: string
        metadata:
          default: null
          description: A read-only metadata association with a custom metric value.
          maxLength: 128
          type:
          - string
          - 'null'
        sampleSize:
          default: 1
          description: Custom metric value sample size.
          type: integer
        segments:
          description: A list of segments for a custom metric used in segmented analysis.
          items:
            $ref: '#/components/schemas/CustomMetricSegment'
          maxItems: 10
          type: array
        timestamp:
          description: Value timestamp.
          format: date-time
          type:
          - string
          - 'null'
        value:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
          description: Custom metric value to ingest.
      required:
      - customMetricId
      - value
      type: object
      x-versionadded: v2.39
    BulkMetricValuesPayload:
      properties:
        buckets:
          description: A list of timestamped buckets with custom metric values.
          items:
            $ref: '#/components/schemas/BulkMetricInputValueBucket'
          maxItems: 10000
          minItems: 1
          type: array
        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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
      required:
      - buckets
      type: object
      x-versionadded: v2.39
    BulkUserInvite:
      properties:
        emails:
          description: A list of user emails to invite.
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        language:
          default: en
          description: Language for the invite email.
          enum:
          - ar_001
          - de_DE
          - en
          - es_419
          - fr
          - ja
          - ko
          - pt_BR
          - test
          - uk_UA
          type: string
        orgId:
          description: Organization ID to invite users to.
          type: string
        resources:
          description: A list of resources to share with the users.
          items:
            $ref: '#/components/schemas/ResourceShare'
          maxItems: 20
          minItems: 1
          type: array
        seatType:
          description: Seat type for the invited users.
          enum:
          - Non-Builder User
          type: string
      required:
      - emails
      type: object
      x-versionadded: v2.41
    BundleSelectionPolicy:
      enum:
      - availability
      title: BundleSelectionPolicy
      type: string
    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).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
      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'
          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.
          type:
          - string
          - 'null'
      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).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
      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 the 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).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
      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
          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:
      description: Each item in `users` refers to the username record and its newly
        assigned role.
      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
          type:
          - string
          - 'null'
        username:
          description: The username of the user to modify access for.
          type: string
      required:
      - role
      - username
      type: object
    CancelCellsExecutionRequest:
      description: Request payload values for canceling notebook cells execution.
      properties:
        cellIds:
          description: List of cell IDs to cancel execution for.
          items:
            type: string
          title: Cellids
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - generation
      - path
      - cellIds
      title: CancelCellsExecutionRequest
      type: object
    CancelExecutionRequest:
      description: Request schema for canceling the execution of cells in a notebook
        session.
      properties:
        cellIds:
          description: List of cell IDs to cancel execution.
          items:
            type: string
          title: Cellids
          type: array
      title: CancelExecutionRequest
      type: object
    CancelScheduledJobsQuery:
      description: Query parameters for canceling scheduled jobs.
      properties:
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      required:
      - useCaseId
      title: CancelScheduledJobsQuery
      type: object
    Capabilities:
      additionalProperties: false
      description: Linux capabilities to add or drop from the container.
      properties:
        add:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Capabilities to add
          title: Add
        drop:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Capabilities to drop
          title: Drop
      title: Capabilities
      type: object
    Catalog:
      description: Stream CSV data chunks from AI catalog dataset
      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:
      description: Stream CSV data chunks from AI catalog dataset
      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.
          type:
          - string
          - 'null'
        id:
          description: Catalog item ID.
          type: string
        message:
          description: Details of exception(s) raised during ingestion process, if
            any.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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
          - files
          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
          - files
          type: string
        dataEngineQueryId:
          description: The ID of the catalog item data engine query.
          type:
          - string
          - 'null'
        dataOrigin:
          description: Data origin of the datasource for this catalog item.
          type:
          - string
          - 'null'
        dataSourceId:
          description: The ID of the catalog item data source.
          type:
          - string
          - 'null'
        description:
          description: Catalog item description.
          type:
          - string
          - 'null'
        error:
          description: The latest error of the catalog item.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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.
          type:
          - integer
          - 'null'
        projectsUsedInCount:
          description: The number of projects that use the catalog item.
          type: integer
        recipeId:
          description: The ID of the catalog item recipe.
          type:
          - string
          - 'null'
        relevance:
          description: ElasticSearch score value or null if search done in Mongo.
          type:
          - number
          - 'null'
        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.
          type:
          - string
          - 'null'
        userBlueprintId:
          description: The ID by which a user blueprint is referenced in User Blueprint
            API.
          type:
          - string
          - 'null'
          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
          - files
          type: string
        dataEngineQueryId:
          description: The ID of the catalog item data engine query.
          type:
          - string
          - 'null'
        dataSourceId:
          description: The ID of the catalog item data source.
          type:
          - string
          - 'null'
        description:
          description: Catalog item description.
          type:
          - string
          - 'null'
        error:
          description: The latest error of the catalog item.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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.
          type:
          - integer
          - 'null'
        projectsUsedInCount:
          description: The number of projects that use the catalog item.
          type: integer
        recipeId:
          description: The ID of the catalog item recipe.
          type:
          - string
          - 'null'
        relevance:
          description: ElasticSearch score value or null if search done in Mongo.
          type:
          - number
          - 'null'
        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.
          type:
          - string
          - 'null'
        userBlueprintId:
          description: The ID by which a user blueprint is referenced in User Blueprint
            API.
          type:
          - string
          - 'null'
          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
    CatalogIdAndVersionMetadata:
      properties:
        catalogId:
          description: The ID of the catalog entry.
          type: string
        catalogVersionId:
          description: The ID of the catalog entry version.
          type: string
        createdBy:
          description: The name or email of the user who created the catalog entity
            version.
          type:
          - string
          - 'null'
        creationDate:
          description: The date when the catalog entity version was created.
          format: date-time
          type: string
        isLatest:
          description: Whether this is the latest version of the catalog entity.
          type: boolean
        isStage:
          description: Whether this is a staged version of the catalog entity.
          type: boolean
        numFiles:
          description: The number of files in the file entity.
          type: integer
        size:
          description: The total size of all files associated with the catalog entity
            version, in bytes.
          type: integer
      required:
      - catalogId
      - catalogVersionId
      - createdBy
      - creationDate
      - isLatest
      - isStage
      - numFiles
      - size
      type: object
      x-versionadded: v2.44
    CatalogListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of catalog item and version IDs.
          items:
            $ref: '#/components/schemas/CatalogIdAndVersionMetadata'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.44
    CatalogListSearchResponse:
      properties:
        cacheHit:
          description: Indicates if the catalog item is returned from the cache.
          type:
          - boolean
          - 'null'
        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.
          type:
          - string
          - 'null'
        previous:
          description: Location of the previous page.
          type:
          - string
          - 'null'
        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
    CatalogRolesWithId:
      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 (e.g., use it to create projects, predictions, etc) data.
            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 catalog entity or `NO_ROLE`
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.37
    CatalogRolesWithNames:
      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 (e.g., use it to create projects, predictions, etc) data.
            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 catalog entity or `NO_ROLE`
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - name
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.37
    CatalogSharedRoles:
      properties:
        applyGrantToLinkedObjects:
          default: false
          description: If `true` for any users being granted access to the entity,
            grant the user read access to any linked objects such as `DataSources`
            and `DataStores` that may be used by this entity. Ignored if no such objects
            are relevant for the entity. This 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 the user making the call
            does not have sufficient permissions to complete the 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. Maximum number of such objects
            is 100.
          items:
            oneOf:
            - $ref: '#/components/schemas/CatalogRolesWithNames'
            - $ref: '#/components/schemas/CatalogRolesWithId'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - operation
      - roles
      type: object
      x-versionadded: v2.37
    Categorical:
      properties:
        allData:
          $ref: '#/components/schemas/PerValueStatistics'
        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.
          type:
          - number
          - 'null'
        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
    CellSchema:
      description: Schema for notebook cell.
      properties:
        attachments:
          description: Cell attachments.
          title: Attachments
          type: object
        cellId:
          description: The ID of the cell.
          title: Cellid
          type: string
        executed:
          allOf:
          - $ref: '#/components/schemas/NotebookTimestampInfo'
          description: The timestamp of when the cell was executed.
          title: Executed
        executionCount:
          description: The execution count of the cell relative to other cells in
            the current session.
          title: Executioncount
          type: integer
        executionId:
          description: The ID of the execution.
          title: Executionid
          type: string
        executionTimeMillis:
          description: The execution time of the cell in milliseconds.
          title: Executiontimemillis
          type: integer
        md5:
          description: The MD5 hash of the cell.
          title: Md5
          type: string
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: The metadata of the cell.
          title: Metadata
        outputType:
          allOf:
          - $ref: '#/components/schemas/OutputStorageType'
          default: RAW_OUTPUT
          description: The type of storage used for the cell output.
        outputs:
          description: The cell outputs.
          items:
            anyOf:
            - $ref: '#/components/schemas/APINotebookCellStreamOutput'
            - $ref: '#/components/schemas/APINotebookCellInputRequest'
            - $ref: '#/components/schemas/APINotebookCellErrorOutput'
            - $ref: '#/components/schemas/APINotebookCellExecuteResultOutput'
            - $ref: '#/components/schemas/APINotebookCellDisplayDataOutput'
          title: Outputs
          type: array
        source:
          description: The contents of the cell, represented as a string.
          title: Source
          type: string
      required:
      - source
      - metadata
      - cellId
      - md5
      title: CellSchema
      type: object
    CellVersionActionSchema:
      description: Schema for taking an action on a notebook cell.
      properties:
        cellId:
          description: The ID of the cell.
          title: Cellid
          type: string
        md5:
          description: The MD5 hash of the cell.
          title: Md5
          type: string
      required:
      - md5
      - cellId
      title: CellVersionActionSchema
      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'
        modelPackage:
          $ref: '#/components/schemas/ModelPackageResponse'
        name:
          description: Name of the challenger.
          type: string
        predictionEnvironment:
          $ref: '#/components/schemas/PredictionEnvironmentResponse'
      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:
      description: Challenger models setting for the deployment.
      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'
          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'
          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'
          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'
          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'
          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'
          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'
          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'
          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'
          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:
      description: The difference between the current entity state and the state of
        the entity if the Change Request gets applied.
      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: The number of items returned on this page.
          type: integer
        data:
          description: List of Approval Policies.
          items:
            $ref: '#/components/schemas/ChangeRequestInfoResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        updatedBy:
          description: Username of the account that last updated the Change Request.
          type:
          - string
          - 'null'
      required:
      - changeRequestId
      - createDate
      - entityId
      - entityName
      - requester
      - state
      - updateDate
      - updatedBy
      type: object
    ChangeRequestRequestReview:
      properties:
        comment:
          description: Free form text to comment on the requested changes.
          maxLength: 10000
          type: string
      type: object
      x-versionadded: v2.38
    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. '
          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'
          - type: 'null'
        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'
        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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        statusChangedBy:
          description: ID of the user who set the current request status. `null` if
            the status was set by the system.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        userOperations:
          $ref: '#/components/schemas/UserOperations'
      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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ChannelCreatedByResponse:
      description: The user who created the template.
      properties:
        firstName:
          description: First Name.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        lastName:
          description: Last Name.
          type:
          - string
          - 'null'
          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
    ChatPromptResponse:
      description: API response object for a single chat prompt.
      properties:
        chatContextId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the chat context for this prompt.
          title: chatContextId
        chatId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the chat this chat prompt belongs to.
          title: chatId
        chatPromptIdsIncludedInHistory:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The list of IDs of the chat prompts included in this prompt's
            history.
          title: chatPromptIdsIncludedInHistory
        citations:
          description: The list of relevant vector database citations (in case of
            using a vector database).
          items:
            $ref: '#/components/schemas/Citation'
          title: citations
          type: array
        confidenceScores:
          anyOf:
          - $ref: '#/components/schemas/ConfidenceScores'
          - type: 'null'
          description: The confidence scores that measure the similarity between the
            prompt context and the prompt completion.
        creationDate:
          description: The creation date of the chat prompt (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the chat prompt.
          title: creationUserId
          type: string
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the chat prompt.
        id:
          description: The ID of the chat prompt.
          title: id
          type: string
        llmBlueprintId:
          description: The ID of the LLM blueprint the chat prompt belongs to.
          title: llmBlueprintId
          type: string
        llmId:
          description: The ID of the LLM used by the chat prompt.
          title: llmId
          type: string
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: A key/value dictionary of LLM settings.
          title: llmSettings
        metadataFilter:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: The metadata dictionary defining the filters that documents
            must match in order to be retrieved.
          title: metadataFilter
        resultMetadata:
          anyOf:
          - $ref: '#/components/schemas/ResultMetadata'
          - type: 'null'
          description: The additional information about the chat prompt results.
        resultText:
          anyOf:
          - type: string
          - type: 'null'
          description: The text of the prompt completion.
          title: resultText
        text:
          description: The text of the user prompt.
          title: text
          type: string
        userName:
          description: The name of the user that created the chat prompt.
          title: userName
          type: string
        vectorDatabaseFamilyId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database family this chat prompt belongs
            to.
          title: vectorDatabaseFamilyId
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database linked to this LLM blueprint.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettings'
          - type: 'null'
          description: A key/value dictionary of vector database settings.
      required:
      - llmId
      - id
      - text
      - llmBlueprintId
      - creationDate
      - creationUserId
      - userName
      - resultMetadata
      - resultText
      - confidenceScores
      - citations
      - executionStatus
      title: ChatPromptResponse
      type: object
    ChatResponse:
      description: Chat object formatted for API output.
      properties:
        creationDate:
          description: The creation date of the chat (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the chat.
          title: creationUserId
          type: string
        id:
          description: The ID of the chat.
          title: id
          type: string
        isFrozen:
          description: Whether the chat is frozen (e.g., an evaluation chat). If the
            chat is frozen, it does not accept new prompts.
          title: isFrozen
          type: boolean
        llmBlueprintId:
          description: The ID of the LLM blueprint associated with the chat.
          title: llmBlueprintId
          type: string
        name:
          description: The name of the chat.
          title: name
          type: string
        promptsCount:
          description: The number of chat prompts in the chat.
          title: promptsCount
          type: integer
        warning:
          anyOf:
          - type: string
          - type: 'null'
          description: Warning about the contents of the chat.
          title: warning
      required:
      - id
      - name
      - llmBlueprintId
      - isFrozen
      - warning
      - creationDate
      - creationUserId
      - promptsCount
      title: ChatResponse
      type: object
    ChatsSortQueryParam:
      description: Sort order values for listing chats.
      enum:
      - name
      - -name
      - creationDate
      - -creationDate
      title: ChatsSortQueryParam
      type: string
    ChunkDefinitionCreate:
      discriminator:
        propertyName: partitionMethod
      oneOf:
      - properties:
          chunkingStrategyType:
            default: rows
            description: The partition method.
            enum:
            - features
            - rows
            type: string
          isDescendingOrder:
            default: false
            description: The sorting order.
            type: boolean
          name:
            description: The name of the chunk definition.
            type:
            - string
            - 'null'
          orderByColumns:
            default: []
            description: The list of the sorting column names.
            items:
              description: Dataset column name.
              type: string
            maxItems: 10
            type: array
          partitionMethod:
            description: The partition method.
            enum:
            - random
            type: string
        required:
        - partitionMethod
        type: object
      - properties:
          chunkingStrategyType:
            default: rows
            description: The partition method.
            enum:
            - features
            - rows
            type: string
          isDescendingOrder:
            default: false
            description: The sorting order.
            type: boolean
          name:
            description: The name of the chunk definition.
            type:
            - string
            - 'null'
          orderByColumns:
            default: []
            description: The list of the sorting column names.
            items:
              description: Dataset column name.
              type: string
            maxItems: 10
            type: array
          partitionMethod:
            description: The partition method.
            enum:
            - stratified
            type: string
          targetClass:
            description: Target Class.
            type: string
          targetColumn:
            description: Target column name.
            type: string
        required:
        - partitionMethod
        - targetClass
        - targetColumn
        type: object
      - properties:
          chunkingStrategyType:
            default: rows
            description: The partition method.
            enum:
            - features
            - rows
            type: string
          datetimePartitionColumn:
            description: Date partition column name.
            type: string
          isDescendingOrder:
            default: false
            description: The sorting order.
            type: boolean
          name:
            description: The name of the chunk definition.
            type:
            - string
            - 'null'
          orderByColumns:
            default: []
            description: The list of the sorting column names.
            items:
              description: Dataset column name.
              type: string
            maxItems: 10
            type: array
          otvTrainingEndDate:
            description: The end date of training data in string format. Format can
              be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
              specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
              This attribute cannot be patched for non-OTV incremental learning projects.
            format: date-time
            type:
            - string
            - 'null'
          otvValidationEndDate:
            description: The end date of validation scoring data in string format.
              Format can be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults
              to UTC.When specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
              This attribute cannot be patched for non-OTV incremental learning projects.
            format: date-time
            type:
            - string
            - 'null'
          otvValidationStartDate:
            description: The start date of validation scoring data in string format.
              Format can be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults
              to UTC.When specifying `ValidationStartDate`, one must specify `ValidationEndDate`.
              This attribute cannot be patched for non-OTV incremental learning projects.
            format: date-time
            type:
            - string
            - 'null'
          partitionMethod:
            description: The partition method.
            enum:
            - date
            type: string
        required:
        - datetimePartitionColumn
        - partitionMethod
        type: object
      x-versionadded: v2.37
    ChunkDefinitionPaginatedResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of chunk definitions.
          items:
            $ref: '#/components/schemas/ChunkDefinitionResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    ChunkDefinitionResponse:
      properties:
        chunkDefinitionStats:
          $ref: '#/components/schemas/ChunkDefinitionStatsResponse'
        chunkingStrategyType:
          default: rows
          description: The partition method.
          enum:
          - features
          - rows
          type: string
        datasetDefinitionId:
          description: The dataset definition ID the definition belongs.
          type: string
        datasetDefinitionInfoVersion:
          description: The version of the dataset definition information.
          type: integer
        featuresChunkDefinition:
          $ref: '#/components/schemas/FeaturesChunkDefinitionResponse'
        id:
          description: The ID of the chunk definition.
          type: string
        isReadonly:
          default: false
          description: Flag the allows or prevents updates.
          type: boolean
        name:
          description: The name of the chunk definition.
          type: string
        partitionMethod:
          default: random
          description: The partition method.
          enum:
          - random
          - stratified
          - date
          type: string
        rowsChunkDefinition:
          $ref: '#/components/schemas/RowsChunkDefinitionResponse'
      required:
      - chunkDefinitionStats
      - chunkingStrategyType
      - datasetDefinitionId
      - datasetDefinitionInfoVersion
      - featuresChunkDefinition
      - id
      - isReadonly
      - name
      - partitionMethod
      - rowsChunkDefinition
      type: object
      x-versionadded: v2.37
    ChunkDefinitionRowsUpdate:
      properties:
        operations:
          $ref: '#/components/schemas/ChunkDefinitionUpdateOperation'
          default: {}
        updates:
          $ref: '#/components/schemas/ChunkDefinitionRowsUpdateFields'
      required:
      - updates
      type: object
      x-versionadded: v2.37
    ChunkDefinitionRowsUpdateFields:
      description: Fields to be updated in the chunk definition.
      properties:
        datetimePartitionColumn:
          description: Date partition column name.
          type: string
        isDescendingOrder:
          description: The sorting order.
          type: boolean
        name:
          description: The name of the chunk definition.
          type: string
        orderByColumns:
          description: The list of the sorting column names.
          items:
            description: Dataset column name.
            type: string
          maxItems: 10
          type: array
        otvTrainingEndDate:
          description: The end date of training data in string format. Format can
            be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
            specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type: string
        otvValidationEndDate:
          description: The end date of validation scoring data in string format. Format
            can be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
            specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type: string
        otvValidationStartDate:
          description: The start date of validation scoring data in string format.
            Format can be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults
            to UTC.When specifying `ValidationStartDate`, one must specify `ValidationEndDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type: string
        targetClass:
          description: Target Class.
          type: string
        targetColumn:
          description: Target column name.
          type: string
        userGroupColumn:
          description: User group column name.
          type: string
      type: object
      x-versionadded: v2.37
    ChunkDefinitionStatsResponse:
      description: Chunk definition stats. This field is auto-generated by the analysis
        job.
      properties:
        expectedChunkSize:
          description: Expected chunk size. this field is auto-generated by the analysis
            job.
          type: integer
        numberOfRowsPerChunk:
          description: Number of rows per chunk. This field is auto-generated by the
            analysis job.
          type: integer
        totalNumberOfChunks:
          description: Total rows of the chunks. This field is auto-generated by the
            analysis job.
          type: integer
      required:
      - expectedChunkSize
      - numberOfRowsPerChunk
      - totalNumberOfChunks
      type: object
      x-versionadded: v2.37
    ChunkDefinitionUpdateOperation:
      description: Operations to perform on the update chunk definition.
      properties:
        forceUpdate:
          default: false
          description: Force update the chunk definition. If set to true, the analysis
            will be reset.
          type: boolean
      type: object
      x-versionadded: v2.37
    ChunkingLengthFunctionNames:
      description: Supported length functions for text splitters.
      enum:
      - tokenizer_length_function
      - approximate_token_count
      title: ChunkingLengthFunctionNames
      type: string
    ChunkingMethodNames:
      description: Supported names of text chunking methods.
      enum:
      - recursive
      - semantic
      title: ChunkingMethodNames
      type: string
    ChunkingMethodNamesTitle:
      description: Supported user-facing friendly ames of text chunking methods.
      enum:
      - Recursive
      - Semantic
      title: ChunkingMethodNamesTitle
      type: string
    ChunkingParameterTypes:
      description: Supported parameter data types for text chunking parameters.
      enum:
      - int
      - list[str]
      - bool
      title: ChunkingParameterTypes
      type: string
    ChunkingParameters:
      description: Chunking parameters for creating a vector database.
      properties:
        chunkOverlapPercentage:
          anyOf:
          - maximum: 50.0
            minimum: 0.0
            type: integer
          - type: 'null'
          description: The chunk overlap percentage to use for text chunking.
          title: chunkOverlapPercentage
        chunkSize:
          anyOf:
          - type: integer
          - type: 'null'
          description: The chunk size to use for text chunking (measured in tokens).
          title: chunkSize
        chunkingMethod:
          anyOf:
          - $ref: '#/components/schemas/ChunkingMethodNames'
          - type: 'null'
          description: The text chunking method to use.
        embeddingModel:
          anyOf:
          - $ref: '#/components/schemas/EmbeddingModelNames'
          - type: 'null'
          description: The name of the embedding model to use. If omitted, DataRobot
            will choose the default embedding model automatically.
        embeddingRegisteredModelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of registered model (in case of using NIM registered
            model for embeddings).
          title: embeddingRegisteredModelId
        embeddingValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The validation ID of the custom embedding model (in case of
            using a custom model for embeddings).
          title: embeddingValidationId
        isSeparatorRegex:
          default: false
          description: Whether the text chunking separator uses a regular expression.
          title: isSeparatorRegex
          type: boolean
        separators:
          anyOf:
          - items:
              maxLength: 20
              type: string
            maxItems: 9
            type: array
          - type: 'null'
          description: The list of separators to use for text chunking.
          title: separators
      title: ChunkingParameters
      type: object
    ChunkingParametersConfig:
      description: Parameters of the text chunkers.
      properties:
        chunkOverlapPercentageMax:
          default: 50
          description: Maximum value of chunk overlap.
          title: chunkOverlapPercentageMax
          type: number
        chunkOverlapPercentageMin:
          default: 0
          description: Minimum value of chunk overlap.
          title: chunkOverlapPercentageMin
          type: number
        chunkOverlapPercentageStep:
          default: 10
          description: Step value of chunk overlap.
          title: chunkOverlapPercentageStep
          type: number
        chunkSizeMaxExp:
          default: 8
          description: Maximum exponent for chunk size (2^8 = 256).
          title: chunkSizeMaxExp
          type: integer
        chunkSizeMinExp:
          default: 7
          description: Minimum exponent for chunk size (2^7 = 128).
          title: chunkSizeMinExp
          type: integer
        chunkingMethods:
          description: List of chunking methods to use.
          items:
            type: string
          title: chunkingMethods
          type: array
        embeddingModelNames:
          description: List of embedding models to use.
          items:
            type: string
          title: embeddingModelNames
          type: array
      required:
      - embeddingModelNames
      title: ChunkingParametersConfig
      type: object
    Citation:
      description: API response object for a single vector database citation.
      properties:
        chunkId:
          anyOf:
          - type: integer
          - type: 'null'
          description: The ID of the chunk in the vector database index.
          title: chunkId
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: LangChain Document metadata information holder.
          title: metadata
        page:
          anyOf:
          - type: integer
          - type: 'null'
          description: The source page number where the citation was found.
          title: page
        similarityScore:
          anyOf:
          - type: number
          - type: 'null'
          description: The similarity score between the citation and the user prompt.
          title: similarityScore
        source:
          anyOf:
          - type: string
          - type: 'null'
          description: The source of the citation (e.g., a filename in the original
            dataset).
          title: source
        startIndex:
          anyOf:
          - type: integer
          - type: 'null'
          description: The chunk's start character index in the source document.
          title: startIndex
        text:
          description: The text of the citation.
          title: text
          type: string
      required:
      - text
      - source
      title: Citation
      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:
      description: Class mapping aggregation settings.
      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
    ClearCellOutputRequest:
      description: Request schema for clearing the output of a notebook cell.
      properties:
        md5:
          description: The MD5 hash of the cell.
          title: Md5
          type: string
      required:
      - md5
      title: ClearCellOutputRequest
      type: object
    ClientCredentialsOAuthFlow:
      description: Configuration for the OAuth 2.0 Client Credentials flow.
      properties:
        refreshUrl:
          description: The URL for refreshing tokens.
          type:
          - string
          - 'null'
        scopes:
          additionalProperties:
            type: string
          description: Available scopes mapping scope name to description.
          type: object
        tokenUrl:
          description: The token URL for the client credentials flow.
          type: string
      required:
      - scopes
      - tokenUrl
      type: object
      x-versionadded: v2.46
    ClientIdAndSecretCredentialsFields:
      properties:
        clientId:
          description: The client ID for integrations that use a client ID and client
            secret (e.g., OAuth client credentials).
          type: string
          x-versionadded: v2.44
        clientSecret:
          description: The client secret for integrations that use a client ID and
            client secret (e.g., OAuth client credentials).
          type: string
          x-versionadded: v2.44
        configId:
          description: The ID of the shared secure configuration for the client ID
            and client secret (managed by an admin).
          type: string
          x-versionadded: v2.44
        credentialType:
          description: The credential type.
          enum:
          - client_id_and_secret
          type: string
      required:
      - credentialType
      type: object
      x-versionadded: v2.45
    CloneFiles:
      properties:
        omit:
          default: null
          description: File names to skip when cloning the files.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
      type: object
      x-versionadded: v2.38
    CloneNotebookFromRevisionRequest:
      description: Request to clone a notebook from a revision.
      properties:
        isAuto:
          default: false
          description: Whether the revision is autosaved.
          title: Isauto
          type: boolean
        name:
          description: Notebook revision name.
          minLength: 1
          title: Name
          type: string
        notebookPath:
          description: Path to the notebook file, if using Codespaces.
          title: Notebookpath
          type: string
      title: CloneNotebookFromRevisionRequest
      type: object
    CloneRepositorySchema:
      description: Schema for cloning a repository.
      properties:
        checkoutRef:
          description: The branch or commit to checkout.
          title: Checkoutref
          type: string
        url:
          description: The URL of the repository to clone.
          title: Url
          type: string
      required:
      - url
      title: CloneRepositorySchema
      type: object
    ClonedNotebookResponse:
      description: Response schema for cloning a notebook from a revision.
      properties:
        notebookId:
          description: Newly cloned notebook ID.
          title: Notebookid
          type: string
      required:
      - notebookId
      title: ClonedNotebookResponse
      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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        uploadInfo:
          $ref: '#/components/schemas/ClusterLicenseRetrieveResponseUploadInfo'
      required:
      - licenseInfo
      - uploadInfo
      type: object
    ClusterLicenseRetrieveResponseLicense:
      description: The license info object will describe detailed information about
        the deployed license
      properties:
        agenticPredictiveGovernanceSeatLicensesLimit:
          description: 'The number of available Agentic, Predictive and Governance
            seat licenses (0: unlimited, -1: no seats available).'
          minimum: -1
          type: integer
          x-versionadded: v2.38
        concurrentWorkersCount:
          description: The number of allowed simultaneously running jobs(concurrent
            workers)
          minimum: 0
          type: integer
        cpuUsageLimit:
          description: 'The CPU usage limit for the cluster (0: unlimited, -1: no
            CPU usage available).'
          minimum: -1
          type: integer
          x-versionadded: v2.39
        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
        genAiSeatLicensesLimit:
          description: 'The number of available GenAI seat licenses (0: unlimited,
            -1: no seats available).'
          minimum: -1
          type: integer
          x-versionadded: v2.36
        gpuUsageLimit:
          description: 'The GPU usage limit for the cluster (0: unlimited, -1: no
            GPU usage available).'
          minimum: -1
          type: integer
          x-versionadded: v2.39
        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
        nonBuilderUserSeatLicensesLimit:
          description: 'The number of available Non-Builder User seat licenses (0:
            unlimited, -1: no seats available).'
          minimum: -1
          type: integer
          x-versionadded: v2.38
        predictiveGovernanceSeatLicensesLimit:
          description: 'The number of available Predictive and Governance seat licenses
            (0: unlimited, -1: no seats available).'
          minimum: -1
          type: integer
          x-versionadded: v2.37
        prepaidDeploymentLimit:
          description: 'The number of prepaid deployments limit (0: unlimited)'
          minimum: 0
          type: integer
      required:
      - agenticPredictiveGovernanceSeatLicensesLimit
      - concurrentWorkersCount
      - cpuUsageLimit
      - expirationTimestamp
      - expired
      - featureFlags
      - genAiSeatLicensesLimit
      - gpuUsageLimit
      - maxDeploymentLimit
      - maximumActiveUsers
      - nonBuilderUserSeatLicensesLimit
      - predictiveGovernanceSeatLicensesLimit
      - prepaidDeploymentLimit
      type: object
    ClusterLicenseRetrieveResponseUploadInfo:
      description: The upload info object will describe detailed information about
        the user who uploaded the current license
      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
    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
    CodeCellSchema:
      description: The schema for a code cell in the notebook.
      properties:
        cellType:
          allOf:
          - $ref: '#/components/schemas/SupportedCellTypes'
          default: code
          description: Type of the cell.
        executionCount:
          default: 0
          description: Execution count of the cell.
          title: Executioncount
          type: integer
        id:
          description: ID of the cell.
          title: Id
          type: string
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: Metadata of the cell.
          title: Metadata
        outputs:
          description: Outputs of the cell.
          items:
            anyOf:
            - $ref: '#/components/schemas/ExecuteResultOutputSchema'
            - $ref: '#/components/schemas/DisplayDataOutputSchema'
            - $ref: '#/components/schemas/StreamOutputSchema'
            - $ref: '#/components/schemas/ErrorOutputSchema'
          title: Outputs
          type: array
        source:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          default: ''
          description: Contents of the cell, represented as a string.
          title: Source
      required:
      - id
      title: CodeCellSchema
      type: object
    CodeCompletionResultSchema:
      description: The schema for the code completion result.
      properties:
        cursorEnd:
          description: The end position of the cursor in the code.
          title: Cursorend
          type: integer
        cursorStart:
          description: The start position of the cursor in the code.
          title: Cursorstart
          type: integer
        matches:
          description: The list of code completions.
          items:
            type: string
          title: Matches
          type: array
      required:
      - matches
      - cursorStart
      - cursorEnd
      title: CodeCompletionResultSchema
      type: object
    CodeCompletionSchema:
      description: The schema for the code completion request.
      properties:
        code:
          description: The code to complete.
          title: Code
          type: string
        cursorPosition:
          description: The position of the cursor in the code.
          title: Cursorposition
          type: integer
      required:
      - code
      - cursorPosition
      title: CodeCompletionSchema
      type: object
    CodeInspectionResultSchema:
      description: The schema for the code inspection result.
      properties:
        data:
          additionalProperties:
            type: string
          description: The inspection result.
          title: Data
          type: object
        found:
          description: True if an object was found, false otherwise.
          title: Found
          type: boolean
      required:
      - data
      - found
      title: CodeInspectionResultSchema
      type: object
    CodeInspectionSchema:
      description: The schema for the code inspection request.
      properties:
        code:
          description: The code to inspect.
          title: Code
          type: string
        cursorPosition:
          description: The position of the cursor in the code.
          title: Cursorposition
          type: integer
        detailLevel:
          description: The detail level of the inspection. Possible values are 0 and
            1.
          title: Detaillevel
          type: integer
      required:
      - code
      - cursorPosition
      - detailLevel
      title: CodeInspectionSchema
      type: object
    CodeRef:
      additionalProperties: false
      properties:
        datarobot:
          $ref: '#/components/schemas/DataRobotCodeRef'
        provider:
          const: datarobot
          default: datarobot
          title: Provider
          type: string
        type:
          const: datarobot
          default: datarobot
          title: Type
          type: string
      required:
      - datarobot
      title: CodeRef
      type: object
    CodeSnippet:
      description: CodeSnippet represents a code snippet.
      properties:
        code:
          description: The code snippet code content.
          title: Code
          type: string
        description:
          description: The description of the code snippet.
          title: Description
          type: string
        id:
          description: The ID of the code snippet.
          title: Id
          type: string
        language:
          description: The programming language of the code snippet.
          title: Language
          type: string
        languageVersion:
          description: The programming language version of the code snippet.
          title: Languageversion
          type: string
        locale:
          description: The language locale of the code snippet.
          title: Locale
          type: string
        tags:
          description: A comma separated list of snippet tags.
          title: Tags
          type: string
        title:
          description: The title of the code snippet.
          title: Title
          type: string
      required:
      - id
      - locale
      - title
      - description
      - code
      - language
      - languageVersion
      title: CodeSnippet
      type: object
    CodeSnippetCreate:
      properties:
        config:
          description: Template type specific configuration used to generate a snippet
            or notebook.
          oneOf:
          - $ref: '#/components/schemas/ModelSnippetModel'
          - $ref: '#/components/schemas/PredictionSnippetModel'
          - $ref: '#/components/schemas/WorkloadSnippet'
        language:
          description: The selected language the generated snippet or notebook should
            be written in.
          enum:
          - curl
          - powershell
          - python
          - qlik
          type: string
        snippetId:
          description: The selected snippet to be returned to the user. This field
            is optional for Prediction snippets.
          maxLength: 255
          minLength: 1
          type: string
        templateType:
          description: The selected template type the generated snippet or notebook
            should be for (i.e. dataset, model, etc.).
          enum:
          - model
          - prediction
          - workload
          type: string
      required:
      - config
      - language
      - templateType
      type: object
      x-versionadded: v2.35
    CodeSnippetItem:
      properties:
        description:
          description: The descriptive text to be displayed in the UI.
          maxLength: 255
          minLength: 1
          type: string
        snippetId:
          description: The ID of this snippet.
          maxLength: 255
          minLength: 1
          type: string
        templating:
          description: A list of templating variables that will be used in the snippet.
          items:
            type: string
          maxItems: 255
          type: array
        title:
          description: The title of the snippet.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - description
      - snippetId
      - templating
      - title
      type: object
      x-versionadded: v2.35
    CodeSnippetListResponse:
      properties:
        codeSnippets:
          description: A list of the available snippets for a given language and template
            type.
          items:
            $ref: '#/components/schemas/CodeSnippetItem'
          maxItems: 22
          type: array
      required:
      - codeSnippets
      type: object
      x-versionadded: v2.35
    CodeSnippetResponse:
      properties:
        codeSnippet:
          description: A UTF-8 encoded code snippet generated for the user.
          type: string
        snippetId:
          description: The selected snippet to be returned to the user.
          type: string
      required:
      - codeSnippet
      - snippetId
      type: object
      x-versionadded: v2.35
    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: The number of items returned on this page.
          type: integer
        data:
          description: The list of combined models.
          items:
            $ref: '#/components/schemas/CommonGetAndListCombinedModel'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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 the 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of combined model segment info.
          items:
            $ref: '#/components/schemas/CombinedModelSegmentsResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CombinedModelSegmentsResponse:
      properties:
        autopilotDone:
          description: Whether autopilot is done for the project.
          type:
          - boolean
          - 'null'
        holdoutUnlocked:
          description: Whether holdout is unlocked for the project.
          type:
          - boolean
          - 'null'
        isFrozen:
          description: Indicates whether the segment champion model is frozen, i.e.,
            uses tuning parameters from a parent model.
          type:
          - boolean
          - 'null'
        modelAssignedBy:
          description: Who assigned the model as segment champion. The default is
            ``DataRobot``.
          type:
          - string
          - 'null'
        modelAwardTime:
          description: The time when the model was awarded as segment champion.
          format: date-time
          type:
          - string
          - 'null'
        modelCount:
          description: The count of trained models in the project.
          type:
          - integer
          - 'null'
        modelIcon:
          description: The number for the icon representing the given champion model.
          items:
            type: integer
          type: array
        modelId:
          description: The ID of the segment champion model.
          type:
          - string
          - 'null'
        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.
          type:
          - object
          - 'null'
        modelType:
          description: The description of the model type of the given champion model.
          type:
          - string
          - 'null'
        projectId:
          description: The ID of the project.
          type:
          - string
          - 'null'
        projectPaused:
          description: Whether the project is paused right now.
          type:
          - boolean
          - 'null'
        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
          type:
          - string
          - 'null'
        projectStageDescription:
          description: A description of the current stage of the project.
          type:
          - string
          - 'null'
        projectStatusError:
          description: Project status error message.
          type:
          - string
          - 'null'
        rowCount:
          description: The count of rows in the project's dataset.
          type:
          - integer
          - 'null'
        rowPercentage:
          description: The percentage of rows in the segment project's dataset compared
            to the original dataset.
          type:
          - number
          - 'null'
        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
          - experimentContainer
          - deployment
          - workload
          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: The number of items returned on this page.
          type: integer
        data:
          description: A list of comments
          items:
            $ref: '#/components/schemas/CommentRetrieve'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - 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'
        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
          - experimentContainer
          - deployment
          - workload
          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
        readonly:
          description: If True, the comment cannot be updated or deleted, False otherwise
          type: boolean
          x-versionadded: v2.38
        updatedAt:
          description: Timestamp when the comment was updated
          type: string
      required:
      - content
      - createdAt
      - createdBy
      - entityId
      - entityType
      - id
      - mentions
      - readonly
      - 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:
      description: User object with information about the commenter
      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 the 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
    CommonLLMSettings:
      additionalProperties: true
      description: The settings that are available for all non-custom LLMs.
      properties:
        maxCompletionLength:
          anyOf:
          - type: integer
          - type: 'null'
          description: Maximum number of tokens allowed in the chat completion. Use
            this value to, for example, control costs on token-based charges or manage
            response length for chat text limits.
          title: maxCompletionLength
        systemPrompt:
          anyOf:
          - maxLength: 5000000
            type: string
          - type: 'null'
          description: System prompt guides the style of the LLM response. It is a
            "universal" prompt, prepended to all individual prompts.
          title: systemPrompt
      title: CommonLLMSettings
      type: object
    CommonSortQueryParams:
      anyOf:
      - const: name
        description: Sort by name in ascending order (A-Z)
        title: Name Ascending
        type: string
      - const: -name
        description: Sort by name in descending order (Z-A)
        title: Name Descending
        type: string
      - const: createdAt
        description: Sort by creation date in ascending order (oldest first)
        title: Creation Date Ascending
        type: string
      - const: -createdAt
        description: Sort by creation date in descending order (newest first)
        title: Creation Date Descending
        type: string
      - const: updatedAt
        description: Sort by update date in ascending order (oldest first)
        title: Update Date Ascending
        type: string
      - const: -updatedAt
        description: Sort by update date in descending order (newest first)
        title: Update Date Descending
        type: string
    ComparisonChatResponse:
      description: Comparison chat object formatted for API output.
      properties:
        creationDate:
          description: The creation date of the comparison chat (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the comparison chat.
          title: creationUserId
          type: string
        id:
          description: The ID of the comparison chat.
          title: id
          type: string
        name:
          description: The name of the comparison chat.
          title: name
          type: string
        playgroundId:
          description: The ID of the playground associated with the comparison chat.
          title: playgroundId
          type: string
        promptsCount:
          description: The number of comparison prompts in the comparison chat.
          title: promptsCount
          type: integer
      required:
      - id
      - name
      - playgroundId
      - creationDate
      - creationUserId
      - promptsCount
      title: ComparisonChatResponse
      type: object
    ComparisonChatsSortQueryParam:
      description: Sort order values for listing comparison chats.
      enum:
      - name
      - -name
      - creationDate
      - -creationDate
      title: ComparisonChatsSortQueryParam
      type: string
    ComparisonPromptFeedbackResult:
      description: Feedback metadata for a comparison prompt result.
      properties:
        comparisonPromptResultId:
          description: The ID of the comparison prompt result associated with this
            feedback.
          title: comparisonPromptResultId
          type: string
        feedbackMetadata:
          $ref: '#/components/schemas/FeedbackMetadata'
          description: The feedback metadata for the comparison prompt result.
      required:
      - comparisonPromptResultId
      - feedbackMetadata
      title: ComparisonPromptFeedbackResult
      type: object
    ComparisonPromptResponse:
      description: ComparisonPrompt object formatted for API output.
      properties:
        comparisonChatId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the comparison chat associated with the comparison
            prompt.
          title: comparisonChatId
        creationDate:
          description: The creation date of the comparison prompt (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the comparison prompt.
          title: creationUserId
          type: string
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the entire comparison prompt.
        id:
          description: The ID of the comparison prompt.
          title: id
          type: string
        metadataFilter:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: The metadata filters applied to the comparison prompt.
          title: metadataFilter
        results:
          description: The list of comparison prompt results.
          items:
            $ref: '#/components/schemas/ComparisonPromptResult'
          title: results
          type: array
        text:
          description: The text of the user prompt.
          title: text
          type: string
        userName:
          description: The name of the user that created the comparison prompt.
          title: userName
          type: string
      required:
      - id
      - text
      - results
      - creationDate
      - creationUserId
      - userName
      - executionStatus
      title: ComparisonPromptResponse
      type: object
    ComparisonPromptResult:
      description: API response object for a single comparison prompt result.
      properties:
        chatContextId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the chat context for this prompt.
          title: chatContextId
        citations:
          description: The list of relevant vector database citations (in case of
            using a vector database).
          items:
            $ref: '#/components/schemas/Citation'
          title: citations
          type: array
        comparisonPromptResultIdsIncludedInHistory:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The list of IDs of the comparison prompt results included in
            this prompt's history.
          title: comparisonPromptResultIdsIncludedInHistory
        confidenceScores:
          anyOf:
          - $ref: '#/components/schemas/ConfidenceScores'
          - type: 'null'
          description: The confidence scores that measure the similarity between the
            prompt context and the prompt completion.
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the comparison prompt by this LLM blueprint.
        id:
          description: The ID of the comparison prompt result.
          title: id
          type: string
        llmBlueprintId:
          description: The ID of the LLM blueprint that produced the result.
          title: llmBlueprintId
          type: string
        resultMetadata:
          anyOf:
          - $ref: '#/components/schemas/ResultMetadata'
          - type: 'null'
          description: The additional information about the prompt result.
        resultText:
          anyOf:
          - type: string
          - type: 'null'
          description: The text of the prompt completion.
          title: resultText
      required:
      - id
      - llmBlueprintId
      - resultText
      - confidenceScores
      - citations
      - executionStatus
      title: ComparisonPromptResult
      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
          - textGeneration
          - 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: The number of items returned on this page.
          type: integer
        data:
          description: List of templates.
          items:
            $ref: '#/components/schemas/TemplateResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - 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
          - textGeneration
          - 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
    ComputeConfusionMatrixRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - (-1, -1)
          - (-1,-1)
          - (0, -1)
          - (0,-1)
          - CV
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_2
          - backtest_20
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - crossValidation
          - externalTestSet
          - holdout
          - validation
          - validation_0
          - validation_1
          type: string
      required:
      - entityId
      - entityType
      - source
      type: object
      x-versionadded: v2.42
    ComputeFeatureEffectsRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The 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
      - entityType
      - source
      type: object
    ComputeFeatureImpactRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          type: string
        rowCount:
          description: The number of rows to use for calculating 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
      - entityType
      - rowCount
      - source
      type: object
    ComputeInsightsResponse:
      properties:
        qid:
          description: The queue ID of the job that computes the insights request.
          type:
          - integer
          - 'null'
      required:
      - qid
      type: object
    ComputeLiftChartRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          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:
      - entityId
      - entityType
      - source
      type: object
    ComputeNewDirectiveArguments:
      description: The transformation description.
      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
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - expression
      - newFeatureName
      - skip
      type: object
    ComputeResidualsRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          type: string
        source:
          description: The subset of data used to compute the insight.
          enum:
          - validation
          - crossValidation
          - holdout
          - externalTestSet
          type: string
      required:
      - entityId
      - entityType
      - source
      type: object
    ComputeRocCurveRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          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:
      - entityId
      - entityType
      - source
      type: object
    ComputeShapDistributionsRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          type: string
        quickCompute:
          default: true
          description: (Deprecated) Limits the number of rows used from the selected
            source by default. Cannot be set to False for this insight.
          type: boolean
        rowCount:
          description: (Deprecated) The number of rows to use for calculating SHAP
            Impact.
          type: integer
          x-versiondeprecated: v2.35
        source:
          description: The subset of data used to compute the insight.
          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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
      required:
      - entityId
      - entityType
      - source
      type: object
      x-versionadded: v2.38
    ComputeShapInsightsRequest:
      properties:
        dataSliceId:
          description: The ID of the data slice.
          type: string
        entityId:
          description: The ID of the entity.
          type: string
        entityType:
          default: datarobotModel
          description: The type of entity for which insights will be calculated.
          enum:
          - datarobotModel
          - customModel
          - vectorDatabase
          type: string
          x-versionadded: v2.34
        externalDatasetId:
          description: The ID of the external dataset.
          type: string
        quickCompute:
          default: true
          description: When enabled, limits the number of rows used from the selected
            source by default. When disabled, all rows are used.
          type: boolean
        rowCount:
          description: (Deprecated) The number of rows to use for calculating SHAP
            Impact.
          type: integer
          x-versionadded: v2.35
          x-versiondeprecated: v2.35
        source:
          description: The subset of data used to compute the insight.
          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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
      required:
      - entityId
      - entityType
      - source
      type: object
      x-versionadded: v2.35
    ConfidenceScores:
      description: API response object for confidence scores.
      properties:
        bleu:
          description: BLEU score.
          title: bleu
          type: number
        meteor:
          description: METEOR score.
          title: meteor
          type: number
        rouge:
          description: ROUGE score.
          title: rouge
          type: number
      required:
      - rouge
      - meteor
      - bleu
      title: ConfidenceScores
      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:
      description: confusion chart data with the format below.
      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: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total count of confusion charts for the 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'
        datasetId:
          description: The dataset ID to retrieve a confusion chart from.
          type: string
        numberOfClasses:
          description: The count of classes in the full confusion matrix.
          type: integer
        rows:
          description: '[rowStart, rowEnd] row dimension of confusion matrix in response'
          items:
            type: integer
          type: array
        totalMatrixSum:
          description: The sum of all values in the 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
    ConfusionMatrixClassMatrix:
      properties:
        actualCount:
          description: The number of times this class was seen in the validation data.
          type: integer
        className:
          description: The name of the class.
          type: string
        confusionMatrixOneVsAll:
          description: 'A 2 dimensional array representing a 2x2 one-vs-all matrix.
            This represents, for each class, the True/False Negative/Positive rates
            as integers. The data structure is: ``[ [ True Negative, False Positive
            ], [ False Negative, True Positive ] ]``.'
          items:
            items:
              type: integer
            maxItems: 10000
            type: array
          maxItems: 10000
          type: array
        f1:
          description: F1 score
          type: number
        precision:
          description: Precision score
          type: number
        predictedCount:
          description: The number of times this class was predicted within the validation
            data.
          type: integer
        recall:
          description: Recall score
          type: number
        wasActualPercentages:
          description: The one-vs-all percentage of actuals, in a format specified
            below.
          items:
            $ref: '#/components/schemas/ActualPercentages'
          maxItems: 10000
          type: array
        wasPredictedPercentages:
          description: The one-vs-all percentages of predicted, in a format specified
            below.
          items:
            $ref: '#/components/schemas/PredictedPercentages'
          maxItems: 10000
          type: array
      required:
      - actualCount
      - className
      - confusionMatrixOneVsAll
      - f1
      - precision
      - predictedCount
      - recall
      - wasActualPercentages
      - wasPredictedPercentages
      type: object
      x-versionadded: v2.42
    ConfusionMatrixData:
      description: The confusion matrix chart data in the format specified below.
      properties:
        classMetrics:
          description: The per-class information, including one-vs-all scores, in
            a format specified below.
          items:
            $ref: '#/components/schemas/ConfusionMatrixClassMatrix'
          maxItems: 10000
          type: array
        colClasses:
          description: Class labels on columns of the confusion matrix.
          items:
            type: string
          maxItems: 10000
          type: array
        confusionMatrix:
          description: 'A two-dimensional array of integers representing the confusion
            matrix, aligned with the `rowClasses` and `colClasses` array. For example,
            if the orientation is `actual`, then when confusionMatrix[A][B], is `true`,the
            result is an integer that represents the number of times ''`class` with
            index A was correct, but class with index B was predicted was true. '
          items:
            items:
              type: integer
            maxItems: 10000
            type: array
          maxItems: 10000
          type: array
        rowClasses:
          description: Class labels on rows of the confusion matrix.
          items:
            type: string
          maxItems: 10000
          type: array
      required:
      - classMetrics
      - colClasses
      - confusionMatrix
      - rowClasses
      type: object
      x-versionadded: v2.42
    ConfusionMatrixInsightsResponse:
      description: The confusion matrix chart data in the format specified below.
      properties:
        columns:
          description: The [colStart, colEnd] column dimension of the confusion matrix
            in responses.
          items:
            type: integer
          maxItems: 10000
          type: array
        confusionMatrixData:
          $ref: '#/components/schemas/ConfusionMatrixData'
        globalMetrics:
          $ref: '#/components/schemas/GlobalMetrics'
        numberOfClasses:
          description: The count of classes in the full confusion matrix.
          type: integer
        rows:
          description: The [rowStart, rowEnd] row dimension of the confusion matrix
            in responses.
          items:
            type: integer
          maxItems: 10000
          type: array
        totalMatrixSum:
          description: The sum of all values in the full confusion matrix.
          type: integer
      required:
      - columns
      - confusionMatrixData
      - globalMetrics
      - numberOfClasses
      - rows
      - totalMatrixSum
      type: object
      x-versionadded: v2.42
    ConfusionMatrixInsightsSingleResponse:
      properties:
        data:
          $ref: '#/components/schemas/ConfusionMatrixInsightsResponse'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The ID of the project.
          type: string
        source:
          description: The data partition used to calculate the insight.
          enum:
          - backtest_0
          - backtest_0Training
          - backtest_1
          - backtest_10
          - backtest_10Training
          - backtest_11
          - backtest_11Training
          - backtest_12
          - backtest_12Training
          - backtest_13
          - backtest_13Training
          - backtest_14
          - backtest_14Training
          - backtest_15
          - backtest_15Training
          - backtest_16
          - backtest_16Training
          - backtest_17
          - backtest_17Training
          - backtest_18
          - backtest_18Training
          - backtest_19
          - backtest_19Training
          - backtest_1Training
          - backtest_2
          - backtest_20
          - backtest_20Training
          - backtest_2Training
          - backtest_3
          - backtest_3Training
          - backtest_4
          - backtest_4Training
          - backtest_5
          - backtest_5Training
          - backtest_6
          - backtest_6Training
          - backtest_7
          - backtest_7Training
          - backtest_8
          - backtest_8Training
          - backtest_9
          - backtest_9Training
          - crossValidation
          - externalTestSet
          - holdout
          - holdoutTraining
          - training
          - validation
          - vectorDatabase
          type: string
      required:
      - data
      - id
      type: object
      x-versionadded: v2.42
    ConnectorFieldSchema:
      properties:
        choices:
          description: If non-empty, the list of all possible values for a parameter.
          items:
            type: string
          type: array
        default:
          description: The default value of the parameter.
          type: string
        description:
          description: The description of the parameter.
          type: string
        name:
          description: The 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:
      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.
      properties:
        ascii:
          $ref: '#/components/schemas/BaseConstraintType'
        float:
          $ref: '#/components/schemas/Float'
        floatList:
          $ref: '#/components/schemas/FloatList'
        int:
          $ref: '#/components/schemas/Int'
        intList:
          $ref: '#/components/schemas/IntList'
        select:
          $ref: '#/components/schemas/Select'
        selectgrid:
          $ref: '#/components/schemas/Select'
          x-versionadded: v2.19
        unicode:
          $ref: '#/components/schemas/BaseConstraintType'
      type: object
    ConsumerInfo:
      properties:
        id:
          description: Consumer ID
          type: string
        name:
          description: Consumer Name
          type:
          - string
          - 'null'
        type:
          description: Consumer Type
          enum:
          - deployment
          - user
          type: string
      required:
      - id
      - name
      - type
      type: object
      x-versionadded: v2.45
    ConsumersResponse:
      properties:
        data:
          description: The span counts for entities.
          items:
            $ref: '#/components/schemas/ConsumerInfo'
          maxItems: 10000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.45
    Container:
      additionalProperties: false
      properties:
        build:
          anyOf:
          - $ref: '#/components/schemas/ContainerBuildInfo'
          - type: 'null'
          description: Server-set image build metadata (e.g. after lock or draft build
            trigger). Workload API clears this on artifact create/update before persistence;
            clients must not rely on sending it.
        description:
          default: ''
          description: Description of the container
          title: Description
          type: string
        entrypoint:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Runtime entrypoint override for the container command. Independent
            of build entrypoint.
          title: Entrypoint
        environmentVars:
          default: []
          description: Environment variables
          items:
            anyOf:
            - $ref: '#/components/schemas/StringEnvironmentVariable'
            - $ref: '#/components/schemas/CredentialEnvironmentVariable'
            - $ref: '#/components/schemas/DrApiTokenEnvironmentVariable'
          title: Environmentvars
          type: array
        imageBuildConfig:
          anyOf:
          - $ref: '#/components/schemas/ImageBuildConfig'
          - type: 'null'
          description: Configuration for server-side image builds from source code.
        imageUri:
          anyOf:
          - type: string
          - type: 'null'
          description: Docker Image URI. Required when imageBuildConfig is not set;
            server-populated after a successful image build.
          title: Imageuri
        livenessProbe:
          anyOf:
          - $ref: '#/components/schemas/ProbeConfig'
          - type: 'null'
          description: Container liveness check configuration
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the container. Lowercase letters, digits, and hyphens
            only; must start with a lowercase letter and end with a letter or digit;
            max 63 characters.
          title: Name
        port:
          anyOf:
          - maximum: 65535.0
            minimum: 1024.0
            type: integer
          - type: 'null'
          description: Container access port. When set, must be >= 1024 for security
            and platform compatibility reasons. Primary containers must define a port;
            non-primary containers must omit it.
          title: Port
        primary:
          anyOf:
          - type: boolean
          - type: 'null'
          default: false
          description: Whether this is the primary container
          title: Primary
        readinessProbe:
          anyOf:
          - $ref: '#/components/schemas/ProbeConfig'
          - type: 'null'
          description: Container readiness check configuration
        securityContext:
          anyOf:
          - $ref: '#/components/schemas/SecurityContext'
          - type: 'null'
          description: Container security context
        startupProbe:
          anyOf:
          - $ref: '#/components/schemas/ProbeConfig'
          - type: 'null'
          description: Container startup check configuration
      title: Container
      type: object
    ContainerBuildInfo:
      additionalProperties: false
      description: Build reference embedded in a container spec when an image build
        is triggered.
      properties:
        artifactImageBuildId:
          description: Artifact Image Build ID
          title: Artifactimagebuildid
          type: string
        createdAt:
          description: Build creation timestamp (UTC)
          format: date-time
          title: Createdat
          type: string
        status:
          description: Image build reported status at submit time
          title: Status
          type: string
      required:
      - artifactImageBuildId
      - status
      - createdAt
      title: ContainerBuildInfo
      type: object
    ContainerGroup:
      additionalProperties: false
      properties:
        containers:
          default: []
          description: List of containers making this container group.
          items:
            $ref: '#/components/schemas/Container'
          title: Containers
          type: array
        name:
          default: default
          description: Name of the container group. Used as the lookup key for runtime
            overrides. Lowercase letters, digits, and hyphens only; must start with
            a lowercase letter and end with a letter or digit; max 63 characters.
          title: Name
          type: string
      title: ContainerGroup
      type: object
    ContainerOverride:
      additionalProperties: false
      description: Runtime diff targeting a single named container within a group.
      properties:
        name:
          description: Container name. Must match a container declared in the artifact
            group.
          title: Name
          type: string
        resourceAllocation:
          anyOf:
          - $ref: '#/components/schemas/ResourceAllocation'
          - type: 'null'
          description: Resource allocation for this container. Required for multi-container
            groups.
      required:
      - name
      title: ContainerOverride
      type: object
    ContainerStatus:
      description: Lifecycle state of a container within a deployment replica.
      enum:
      - running
      - waiting
      - terminated
      - unknown
      title: ContainerStatus
      type: string
    ContainerStatusDetail:
      additionalProperties: false
      properties:
        image:
          title: Image
          type: string
        name:
          title: Name
          type: string
        ready:
          title: Ready
          type: boolean
        restartCount:
          title: Restartcount
          type: integer
        startedAt:
          anyOf:
          - type: string
          - type: 'null'
          title: Startedat
        status:
          $ref: '#/components/schemas/ContainerStatus'
      required:
      - name
      - status
      - startedAt
      - ready
      - restartCount
      - image
      title: ContainerStatusDetail
      type: object
    ContextItem:
      properties:
        context:
          description: Text generation context.
          type: string
        link:
          description: Text generation context link.
          type:
          - string
          - 'null'
      required:
      - context
      type: object
      x-versionadded: v2.35
    ConversionCreateQuery:
      properties:
        mainProgramItemId:
          description: The main program file item ID.
          type: string
          x-versionadded: v2.26
      required:
      - mainProgramItemId
      type: object
    ConversionListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of custom model conversions.
          items:
            $ref: '#/components/schemas/ConversionResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.26
        conversionSucceeded:
          description: Indication for a successful custom model conversion.
          type:
          - boolean
          - 'null'
          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'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.26
        mainProgramItemId:
          description: The main program file item ID.
          type:
          - string
          - 'null'
          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
    ConvertToCodespaceRequest:
      description: Request schema for converting a notebook to a codespace.
      properties:
        useCaseDescription:
          description: The description of the Use Case.
          maxLength: 500
          title: Usecasedescription
          type: string
        useCaseId:
          description: The ID of the Use Case to associate the notebook with.
          title: Usecaseid
          type: string
        useCaseName:
          description: The name of the Use Case to associate the notebook with.
          title: Usecasename
          type: string
      title: ConvertToCodespaceRequest
      type: object
    CopyBatch:
      properties:
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict in the target location.\n\
            RENAME (default): rename a duplicate file using \u201C<filename> (n).ext\u201D\
            \ pattern.\nREPLACE: prefer files you copy.\nSKIP: prefer files existing\
            \ in the *target*.\nERROR: fail with an error in case of a naming conflict. "
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        sources:
          description: File and folder names to copy. Folders are identified by ending
            with '/'.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        target:
          default: null
          description: Either a target folder to copy *sources* into or a target file
            name to copy a single file and rename it on copy.Folders are identified
            by ending with '/'.
          type:
          - string
          - 'null'
        targetCatalogId:
          default: null
          description: Target catalog ID to copy files into. Copy files within the
            same catalog item if no *targetCatalogId* is provided.
          type:
          - string
          - 'null'
      required:
      - overwrite
      - sources
      type: object
      x-versionadded: v2.38
    CopyFileOrFolder:
      properties:
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict in the target location.\n\
            RENAME (default): rename a duplicate file using \u201C<filename> (n).ext\u201D\
            \ pattern.\nREPLACE: prefer the file you copy.\nSKIP: prefer the file\
            \ existing in the *target*.\nERROR: fail with an error in case of a naming\
            \ conflict. "
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        source:
          description: The file or folder path to copy. Folder paths should end with
            '/'.
          type: string
        target:
          description: The new file or folder path to copy to. Folders paths should
            end with '/'.
          type: string
      required:
      - overwrite
      - source
      - target
      type: object
      x-versionadded: v2.42
    CopyFilesystemObjectRequest:
      description: Copy filesystem object request schema.
      properties:
        operations:
          description: List of source-destination pairs.
          items:
            $ref: '#/components/schemas/SourceDestinationSchema'
          title: Operations
          type: array
        overrideExisting:
          default: false
          description: Whether to override existing files or directories.
          title: Overrideexisting
          type: boolean
      title: CopyFilesystemObjectRequest
      type: object
    CopyInsightsRequest:
      description: The body of the Copy Insights request.
      properties:
        sourcePlaygroundId:
          description: The ID of the existing playground from where to copy insights.
          title: sourcePlaygroundId
          type: string
        withEvaluationDatasets:
          default: false
          description: If `true` also copies source playground evaluation datasets
            to target playground.
          title: withEvaluationDatasets
          type: boolean
      required:
      - sourcePlaygroundId
      title: CopyInsightsRequest
      type: object
    CopySupportedInsightsRequest:
      description: The body of the "Copy supported insights" request.
      properties:
        addToExisting:
          default: true
          description: If `true`, adds copied insights to existing insights in the
            target playground. If `false`, replaces insights in the target playground
            with copied insights.
          title: addToExisting
          type: boolean
        withEvaluationDatasets:
          default: false
          description: If `true` also copies source playground evaluation datasets
            to target playground.
          title: withEvaluationDatasets
          type: boolean
      title: CopySupportedInsightsRequest
      type: object
    CostMetricConfigurationResponse:
      description: API response object for a single cost metric configuration.
      properties:
        costConfigurationId:
          description: The ID of the cost metric configuration.
          title: costConfigurationId
          type: string
        costMetricConfigurations:
          description: The list of individual LLM cost configurations that constitute
            this cost metric configuration.
          items:
            $ref: '#/components/schemas/LLMCostConfigurationResponse'
          title: costMetricConfigurations
          type: array
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name to use for the cost configuration.
          title: name
        playgroundId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the playground associated with the cost metric configuration.
          title: playgroundId
        useCaseId:
          description: The ID of the use case associated with the cost metric configuration.
          title: useCaseId
          type: string
      required:
      - costConfigurationId
      - useCaseId
      - costMetricConfigurations
      title: CostMetricConfigurationResponse
      type: object
    CreateAndStartCodespaceSchema:
      description: Schema for creating and starting a codespace.
      properties:
        cloneRepository:
          allOf:
          - $ref: '#/components/schemas/CloneRepositorySchema'
          description: The repository to clone for the codespace.
          title: Clonerepository
        description:
          description: The description of the codespace.
          title: Description
          type: string
        environment:
          allOf:
          - $ref: '#/components/schemas/ExecutionEnvironmentAssignRequest'
          description: The environment for the codespace.
          title: Environment
        environmentVariables:
          description: The environment variables for the codespace.
          items:
            $ref: '#/components/schemas/NewEnvironmentVariableSchema'
          title: Environmentvariables
          type: array
        exposedPorts:
          description: The exposed ports for the codespace.
          items:
            $ref: '#/components/schemas/ExposePortSchema'
          title: Exposedports
          type: array
        name:
          default: Untitled Codespace
          description: The name of the codespace.
          title: Name
          type: string
        openFilePaths:
          description: The file paths to open in the codespace.
          items:
            type: string
          title: Openfilepaths
          type: array
        settings:
          allOf:
          - $ref: '#/components/schemas/NotebookSettings'
          description: The settings for the codespace.
          title: Settings
        tags:
          description: The tags associated with the codespace.
          items:
            type: string
          title: Tags
          type: array
        useCaseId:
          description: The ID of the use case associated with the codespace.
          title: Usecaseid
          type: string
      required:
      - useCaseId
      title: CreateAndStartCodespaceSchema
      type: object
    CreateCellRequest:
      description: Request schema for creating a notebook cell.
      properties:
        afterCellId:
          anyOf:
          - type: string
          - enum:
            - FIRST
            type: string
          description: The ID of the cell after which to create the new cell.
          title: Aftercellid
        attachments:
          description: The attachments associated with the cell.
          title: Attachments
          type: object
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: The metadata associated with the cell.
          title: Metadata
        source:
          description: The contents of the cell, represented as a string.
          title: Source
          type: string
      required:
      - afterCellId
      - source
      title: CreateCellRequest
      type: object
    CreateCellsRequest:
      description: Request payload values for creating notebook cells.
      properties:
        actionId:
          description: Action ID of notebook update request.
          maxLength: 64
          title: Actionid
          type: string
        cells:
          description: List of cells to create.
          items:
            $ref: '#/components/schemas/InsertCellsSchema'
          title: Cells
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - generation
      - path
      - cells
      title: CreateCellsRequest
      type: object
    CreateCellsResponse:
      description: Response schema for creating notebook cells.
      properties:
        actionId:
          description: Action ID of the notebook update request.
          title: Actionid
          type: string
        cellIds:
          description: List of cell IDs of the created cells.
          items:
            type: string
          title: Cellids
          type: array
      required:
      - actionId
      - cellIds
      title: CreateCellsResponse
      type: object
    CreateChatPromptRequest:
      description: The body of the "Create chat prompt" request.
      properties:
        chatId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the chat this prompt belongs to. If LLM and vector
            database settings are not specified in the request, then the prompt will
            use the current settings of the chat.
          title: chatId
        llmBlueprintId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM blueprint this prompt belongs to. If LLM
            and vector database settings are not specified in the request, then the
            prompt will use the current settings of the LLM blueprint.
          title: llmBlueprintId
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, uses this LLM ID for the prompt and updates the
            settings of the corresponding chat or LLM blueprint to use this LLM ID.
          title: llmId
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: If specified, uses these LLM settings for the prompt and updates
            the settings of the corresponding chat or LLM blueprint to use these LLM
            settings.
          title: llmSettings
        metadataFilter:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: The metadata fields to add to the chat prompt.
          title: metadataFilter
        text:
          description: The text of the user prompt.
          maxLength: 5000000
          title: text
          type: string
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, uses this vector database ID for the prompt and
            updates the settings of the corresponding chat or LLM blueprint to use
            this vector database ID.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettings'
          - type: 'null'
          description: If specified, uses these vector database settings for the prompt
            and updates the settings of the corresponding chat or LLM blueprint to
            use these vector database settings.
      required:
      - text
      title: CreateChatPromptRequest
      type: object
    CreateChatRequest:
      description: The body of the "Create chat" request.
      properties:
        llmBlueprintId:
          description: The ID of the LLM blueprint to associate with the chat.
          title: llmBlueprintId
          type: string
        name:
          description: The name of the chat.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
      required:
      - name
      - llmBlueprintId
      title: CreateChatRequest
      type: object
    CreateComparisonChatRequest:
      description: The body of the "Create comparison chat" request.
      properties:
        name:
          description: The name of the comparison chat.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
        playgroundId:
          description: The ID of the playground to associate with the comparison chat.
          title: playgroundId
          type: string
      required:
      - name
      - playgroundId
      title: CreateComparisonChatRequest
      type: object
    CreateComparisonPromptRequest:
      description: The body of the "Create comparison prompt" request.
      properties:
        comparisonChatId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the comparison chat to associate the comparison prompt
            with.
          title: comparisonChatId
        llmBlueprintIds:
          description: The list of LLM blueprint IDs that should execute the comparison
            prompt.
          items:
            type: string
          maxItems: 10
          title: llmBlueprintIds
          type: array
        metadataFilter:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: The metadata dict that defines filters that the retrieved documents
            need to match.
          title: metadataFilter
        text:
          description: The text of the user prompt.
          maxLength: 5000000
          title: text
          type: string
      required:
      - llmBlueprintIds
      - text
      title: CreateComparisonPromptRequest
      type: object
    CreateCostMetricConfigurationRequest:
      description: The body of the "Create cost metric configuration" request.
      properties:
        costMetricConfigurations:
          description: The list of cost metric configurations to use.
          items:
            $ref: '#/components/schemas/LLMCostConfigurationResponse'
          title: costMetricConfigurations
          type: array
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name to use for the cost configuration.
          title: name
        playgroundId:
          description: The ID of the playground to associate with the cost metric
            configuration.
          title: playgroundId
          type: string
        useCaseId:
          description: The ID of the use case to associate with the cost metric configuration.
          title: useCaseId
          type: string
      required:
      - useCaseId
      - playgroundId
      - costMetricConfigurations
      title: CreateCostMetricConfigurationRequest
      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_oauth
          - azure_sas
          - azure_service_principal
          - basic
          - bearer
          - box_jwt
          - client_id_and_secret
          - databricks_access_token_account
          - databricks_service_principal_account
          - external_oauth_provider
          - gcp
          - oauth
          - rsa
          - s3
          - sap_oauth
          - 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
            maxItems: 1000
            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'
          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
        runtimeParameters:
          description: Full snapshot of runtime parameters. Parameters not in this
            list will be removed. Supports create, update, and delete operations.
          type: string
          x-datarobot-public-preview: false
          x-datarobot-required-feature-flags:
          - description: Enables the addition of key-value pairs as Runtime-Parameters
              for Custom Inference Models.
            enabled_by_default: true
            maturity: GA_ALL
            name: CUSTOM_MODEL_RUNTIME_PARAMETERS
      required:
      - name
      type: object
    CreateCustomJobFromTemplateGallery:
      properties:
        description:
          description: The description of the custom job.
          maxLength: 10000
          type: string
        environmentId:
          description: The ID of the execution environment to use for this custom
            job.
          type: string
        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
        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
            maxItems: 1000
            type: array
        jobType:
          default: default
          description: Type of the custom job.
          enum:
          - default
          - hostedCustomMetric
          - notification
          - retraining
          type: string
        resources:
          $ref: '#/components/schemas/CustomJobResources'
        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
        runtimeParameters:
          description: Full snapshot of runtime parameters. Parameters not in this
            list will be removed. Supports create, update, and delete operations.
          type: string
          x-datarobot-public-preview: false
          x-datarobot-required-feature-flags:
          - description: Enables the addition of key-value pairs as Runtime-Parameters
              for Custom Inference Models.
            enabled_by_default: true
            maturity: GA_ALL
            name: CUSTOM_MODEL_RUNTIME_PARAMETERS
        templateId:
          description: Custom Job Template ID.
          type: string
      required:
      - templateId
      type: object
      x-versionadded: v2.35
    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'
          maxItems: 100
          type: array
          x-versionadded: v2.33
      type: object
    CreateCustomModelEmbeddingValidationRequest:
      description: The body of the "Validate custom model" request.
      properties:
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the model used in the deployment.
          title: modelId
        name:
          default: Untitled
          description: The name to use for the validated custom model.
          maxLength: 5000
          title: name
          type: string
        predictionTimeout:
          default: 300
          description: The timeout in seconds for the prediction when validating a
            custom model. Defaults to 300.
          maximum: 600.0
          minimum: 1.0
          title: predictionTimeout
          type: integer
        promptColumnName:
          description: The name of the column the custom model uses for prompt text
            input.
          maxLength: 5000
          title: promptColumnName
          type: string
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          maxLength: 5000
          title: targetColumnName
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case to associate with the validated custom
            model.
          title: useCaseId
      required:
      - deploymentId
      - promptColumnName
      - targetColumnName
      title: CreateCustomModelEmbeddingValidationRequest
      type: object
    CreateCustomModelLLMValidationRequest:
      description: The body of the "Validate custom model" request.
      properties:
        chatModelId:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The model ID to specify when calling the OpenAI chat completion
            API of the deployment. If this parameter is specified, the deployment
            must support the OpenAI chat completion API.
          title: chatModelId
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the model used in the deployment.
          title: modelId
        name:
          default: Untitled
          description: The name to use for the validated custom model.
          maxLength: 5000
          title: name
          type: string
        predictionTimeout:
          default: 300
          description: The timeout in seconds for the prediction when validating a
            custom model. Defaults to 300.
          maximum: 600.0
          minimum: 1.0
          title: predictionTimeout
          type: integer
        promptColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the column the custom model uses for prompt text
            input. This value is used to call the Prediction API of the deployment.
            For LLM deployments that support the OpenAI chat completion API, it is
            recommended to specify `chatModelId` instead.
          title: promptColumnName
        targetColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the column the custom model uses for prediction
            output. This value is used to call the Prediction API of the deployment.
            For LLM deployments that support the OpenAI chat completion API, it is
            recommended to specify `chatModelId` instead.
          title: targetColumnName
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case to associate with the validated custom
            model.
          title: useCaseId
      required:
      - deploymentId
      title: CreateCustomModelLLMValidationRequest
      type: object
    CreateCustomModelVectorDatabaseFromDeploymentRequest:
      description: The body of the "Create vector database from custom model deployment"
        request.
      properties:
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        modelId:
          description: The ID of the model in the custom model deployment.
          title: modelId
          type: string
        name:
          description: The name of the vector database.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
        promptColumnName:
          description: The name of the column the custom model uses for prompt text
            input.
          maxLength: 5000
          title: promptColumnName
          type: string
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          maxLength: 5000
          title: targetColumnName
          type: string
        useCaseId:
          description: The ID of the use case to link the vector database to.
          title: useCaseId
          type: string
      required:
      - name
      - useCaseId
      - promptColumnName
      - targetColumnName
      - deploymentId
      - modelId
      title: CreateCustomModelVectorDatabaseFromDeploymentRequest
      type: object
    CreateCustomModelVectorDatabaseFromValidationIdPayload:
      description: The body of the "Create vector database from validation ID" request.
      properties:
        name:
          description: The name of the vector database.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
        useCaseId:
          description: The ID of the use case to link the vector database to.
          title: useCaseId
          type: string
        validationId:
          description: The validation ID of the custom model validation.
          title: validationId
          type: string
      required:
      - name
      - useCaseId
      - validationId
      title: CreateCustomModelVectorDatabaseFromValidationIdPayload
      type: object
    CreateCustomModelVectorDatabaseValidationRequest:
      description: The body of the "Validate custom model" request.
      properties:
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the model used in the deployment.
          title: modelId
        name:
          default: Untitled
          description: The name to use for the validated custom model.
          maxLength: 5000
          title: name
          type: string
        predictionTimeout:
          default: 300
          description: The timeout in seconds for the prediction when validating a
            custom model. Defaults to 300.
          maximum: 600.0
          minimum: 1.0
          title: predictionTimeout
          type: integer
        promptColumnName:
          description: The name of the column the custom model uses for prompt text
            input.
          maxLength: 5000
          title: promptColumnName
          type: string
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          maxLength: 5000
          title: targetColumnName
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case to associate with the validated custom
            model.
          title: useCaseId
      required:
      - deploymentId
      - promptColumnName
      - targetColumnName
      title: CreateCustomModelVectorDatabaseValidationRequest
      type: object
    CreateCustomModelVersionRequest:
      description: The body of the "Create custom model version" request.
      properties:
        defaultPredictionServerId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of a prediction server for the new deployment to use.
            Only used if this LLM blueprint's vector database is not already deployed.
            Cannot be used with predictionEnvironmentId.
          title: defaultPredictionServerId
        insightsConfiguration:
          default: []
          description: The configuration of insights to transfer to production.
          items:
            $ref: '#/components/schemas/InsightsConfigurationWithAdditionalData'
          minItems: 0
          title: insightsConfiguration
          type: array
        llmBlueprintId:
          description: The ID of the LLM blueprint to use for the custom model version.
          title: llmBlueprintId
          type: string
        llmTestConfigurationIds:
          default: []
          description: The IDs of the LLM test configurations to execute.
          items:
            type: string
          maxItems: 100
          title: llmTestConfigurationIds
          type: array
        predictionEnvironmentId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the prediction environment for a new vector database
            deployment to use. Only used if this LLM blueprint's vector database is
            not already deployed. Cannot be used with defaultPredictionServerId.
          title: predictionEnvironmentId
        promptColumnName:
          default: promptText
          description: The name of the column to use for prompt text input in the
            custom model.
          maxLength: 5000
          title: promptColumnName
          type: string
        targetColumnName:
          default: resultText
          description: The name of the column to use for prediction output in the
            custom model.
          maxLength: 5000
          title: targetColumnName
          type: string
        vectorDatabaseResources:
          anyOf:
          - $ref: '#/components/schemas/CustomModelResourcesRequest'
          - type: 'null'
          description: The resources that the vector database custom model will be
            provisioned with. Only used if this LLM blueprint's vector database is
            not already deployed.
      required:
      - llmBlueprintId
      title: CreateCustomModelVersionRequest
      type: object
    CreateCustomModelVersionResponse:
      description: API response object for the "Create custom model version" request.
      properties:
        customModelId:
          description: The ID of the created custom model.
          title: customModelId
          type: string
      required:
      - customModelId
      title: CreateCustomModelVersionResponse
      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'
        generatorType:
          description: Type of data engine query generator
          enum:
          - TimeSeries
          type: string
      required:
      - datasets
      - generatorSettings
      - generatorType
      type: object
    CreateDataStageRequest:
      properties:
        filename:
          description: The filename associated with the stage.
          type: string
      required:
      - filename
      type: object
      x-versionadded: v2.35
    CreateDataStageResponse:
      properties:
        id:
          description: The ID of the data stage object.
          type: string
      required:
      - id
      type: object
      x-versionadded: v2.35
    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'
          type:
          - string
          - 'null'
        configurationId:
          description: Driver configuration ID if it was provided during driver upload.
          type:
          - string
          - 'null'
          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
          - datasphere-v1
          - salesforce-v1
          - trino-v1
          type:
          - string
          - 'null'
          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
    CreateEnvironmentVariablesRequestSchema:
      description: Create environment variables request schema.
      properties:
        data:
          description: List of environment variables to create.
          items:
            $ref: '#/components/schemas/NewEnvironmentVariableSchema'
          title: Data
          type: array
      title: CreateEnvironmentVariablesRequestSchema
      type: object
    CreateEvaluationDatasetConfigurationRequest:
      description: The body of the "Create evaluation dataset configuration" request.
      properties:
        agentGoalsColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The name of the dataset column containing expected agent goals.
            It is required to evaluate the AgentGoalAccuracyWithReference metric for
            agentic workflows.
          title: agentGoalsColumnName
        correctnessEnabled:
          anyOf:
          - type: boolean
          - type: 'null'
          deprecated: true
          description: Whether correctness is enabled for the evaluation dataset configuration.
          title: correctnessEnabled
        datasetId:
          description: The ID of the evaluation dataset.
          title: datasetId
          type: string
        isSyntheticDataset:
          default: false
          description: Whether the evaluation dataset is synthetic.
          title: isSyntheticDataset
          type: boolean
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the evaluation dataset configuration.
          title: name
        playgroundId:
          description: The ID of the playground to associate with the evaluation dataset
            configuration.
          title: playgroundId
          type: string
        promptColumnName:
          description: The name of the dataset column containing the prompt text.
          title: promptColumnName
          type: string
        responseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing the response text.
          title: responseColumnName
        toolCallsColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The name of the dataset column containing expected tool calls.
            It is required to evaluate the ToolCallAccuracy metric for agentic workflows.
          title: toolCallsColumnName
        useCaseId:
          description: The ID of the use case to associate with the evaluation dataset
            configuration.
          title: useCaseId
          type: string
      required:
      - useCaseId
      - playgroundId
      - datasetId
      - promptColumnName
      title: CreateEvaluationDatasetConfigurationRequest
      type: object
    CreateEvaluationDatasetMetricAggregationRequest:
      description: The body of the "Create evaluation dataset metric aggregation"
        request.
      properties:
        chatName:
          default: Aggregated chat
          description: The name for the new chat that will contain the associated
            prompts and responses.
          maxLength: 5000
          title: chatName
          type: string
        evaluationDatasetConfigurationId:
          description: The ID of the evaluation dataset configuration.
          title: evaluationDatasetConfigurationId
          type: string
        insightsConfiguration:
          description: The configuration of insights for the metric aggregation.
          items:
            $ref: '#/components/schemas/InsightsConfigurationWithAdditionalData'
          minItems: 1
          title: insightsConfiguration
          type: array
        llmBlueprintIds:
          description: The IDs of the LLM blueprints to use for the metric aggregation.
          items:
            type: string
          maxItems: 3
          minItems: 1
          title: llmBlueprintIds
          type: array
      required:
      - llmBlueprintIds
      - evaluationDatasetConfigurationId
      - insightsConfiguration
      title: CreateEvaluationDatasetMetricAggregationRequest
      type: object
    CreateEvaluationDatasetMetricAggregationResponse:
      description: The body of the "Create evaluation dataset metric aggregation"
        response.
      properties:
        chatIds:
          description: The IDs of the chats associated with the metric aggregation.
          items:
            type: string
          title: chatIds
          type: array
        jobId:
          description: The ID of the evaluation dataset metric aggregation job.
          format: uuid4
          title: jobId
          type: string
      required:
      - jobId
      - chatIds
      title: CreateEvaluationDatasetMetricAggregationResponse
      type: object
    CreateEventRequest:
      description: Schema for create event request.
      properties:
        body:
          $ref: '#/components/schemas/EventBody'
          description: Event body.
        emitter:
          $ref: '#/components/schemas/EmitterDataModel'
          description: Emitter information.
        type:
          $ref: '#/components/schemas/EventType'
          default: message
          description: Event type.
      required:
      - body
      - emitter
      title: CreateEventRequest
      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
    CreateFilesystemObjectRequest:
      description: Create a new filesystem object request schema.
      properties:
        isDirectory:
          description: Whether the filesystem object is a directory or not.
          title: Isdirectory
          type: boolean
        path:
          description: Path to the filesystem object.
          title: Path
          type: string
      required:
      - path
      - isDirectory
      title: CreateFilesystemObjectRequest
      type: object
    CreateFromChatPromptRequest:
      description: The body of the Create LLM Blueprint from a ChatPrompt request.
      properties:
        chatPromptId:
          description: The ID of an existing chat prompt to copy the LLM and vector
            database settings from.
          title: chatPromptId
          type: string
        description:
          default: ''
          description: The description of the new LLM blueprint.
          maxLength: 5000
          title: description
          type: string
        name:
          description: The name of the new LLM blueprint.
          maxLength: 5000
          title: name
          type: string
      required:
      - name
      - chatPromptId
      title: CreateFromChatPromptRequest
      type: object
    CreateFromLLMBlueprintRequest:
      description: The body of the Create LLM Blueprint from an LLM Blueprint request.
      properties:
        description:
          default: ''
          description: The description of the new LLM blueprint.
          maxLength: 5000
          title: description
          type: string
        llmBlueprintId:
          description: The ID of an existing LLM blueprint to copy the LLM and vector
            database settings from.
          title: llmBlueprintId
          type: string
        name:
          description: The name of the new LLM blueprint.
          maxLength: 5000
          title: name
          type: string
      required:
      - name
      - llmBlueprintId
      title: CreateFromLLMBlueprintRequest
      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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          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
          x-versionadded: v2.33
        name:
          description: Name to be assigned to the 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
        skipDuplicateDatesValidation:
          default: false
          description: By default, if a recipe contains time series or a time series
            resampling operation, publishing fails if there are date duplicates to
            prevent data quality issues and ambiguous transformations. If set to True,
            then validation will be skipped.
          type: boolean
          x-versionadded: v2.36
        useKerberos:
          default: false
          description: If true, use kerberos authentication for database authentication.
          type: boolean
          x-versionadded: v2.33
      required:
      - recipeId
      type: object
    CreateLLMBlueprintRequest:
      description: The body of the Create LLM Blueprint request.
      properties:
        description:
          default: ''
          description: The description of the LLM blueprint.
          maxLength: 5000
          title: description
          type: string
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM selected for this LLM blueprint.
          title: llmId
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: A key/value dictionary of LLM settings.
          title: llmSettings
        name:
          description: The name of the LLM blueprint.
          maxLength: 5000
          title: name
          type: string
        playgroundId:
          description: The ID of the playground to link this LLM blueprint to.
          title: playgroundId
          type: string
        promptType:
          $ref: '#/components/schemas/PromptType'
          default: CHAT_HISTORY_AWARE
          description: Specifies whether chat history is submitted as context to the
            user prompt.
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database linked to this LLM blueprint.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettingsRequest'
          - type: 'null'
          description: A key/value dictionary of vector database settings.
      required:
      - playgroundId
      - name
      title: CreateLLMBlueprintRequest
      type: object
    CreateLLMTestConfigurationRequest:
      description: Request object for creating a LLMTestConfiguration.
      properties:
        datasetEvaluations:
          description: Dataset evaluations.
          items:
            $ref: '#/components/schemas/DatasetEvaluationRequest'
          maxItems: 10
          minItems: 1
          title: datasetEvaluations
          type: array
        description:
          default: ''
          description: LLM test configuration description.
          maxLength: 5000
          title: description
          type: string
        llmTestGradingCriteria:
          $ref: '#/components/schemas/LLMTestGradingCriteria'
          description: LLM test grading criteria.
        name:
          description: LLM test configuration name.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
        useCaseId:
          description: The use case ID associated with the LLM Test configuration.
          title: useCaseId
          type: string
      required:
      - name
      - useCaseId
      - datasetEvaluations
      - llmTestGradingCriteria
      title: CreateLLMTestConfigurationRequest
      type: object
    CreateLLMTestResultRequest:
      description: Request object for creating a LLMTestResult.
      properties:
        llmBlueprintId:
          description: The LLM Blueprint ID associated with the LLM Test result.
          title: llmBlueprintId
          type: string
        llmTestConfigurationId:
          description: The use case ID associated with the LLM Test result.
          title: llmTestConfigurationId
          type: string
      required:
      - llmTestConfigurationId
      - llmBlueprintId
      title: CreateLLMTestResultRequest
      type: object
    CreateLLMTestSuiteRequest:
      description: The body of the "Create LLM test suite" request.
      properties:
        description:
          default: ''
          description: The description of the LLM test suite.
          maxLength: 5000
          title: description
          type: string
        llmTestConfigurationIds:
          default: []
          description: The IDs of the LLM test configurations in the LLM test suite.
          items:
            type: string
          maxItems: 100
          title: llmTestConfigurationIds
          type: array
        name:
          description: The name of the LLM test suite.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
        useCaseId:
          description: The ID of the use case to associate with the LLM test suite.
          title: useCaseId
          type: string
      required:
      - name
      - useCaseId
      title: CreateLLMTestSuiteRequest
      type: object
    CreateManualRunRequest:
      description: Request to create a manual run for a scheduled job.
      properties:
        manualRunType:
          allOf:
          - $ref: '#/components/schemas/ManualRunTypes'
          default: manual
          description: The type of manual run. Possible values are 'manual' or 'pipeline'.
        notebookId:
          description: The ID of the notebook to schedule.
          title: Notebookid
          type: string
        notebookPath:
          description: The path to the notebook in the file system if a Codespace
            is being used.
          title: Notebookpath
          type: string
        parameters:
          description: The parameters to pass to the notebook when it runs.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
        title:
          description: The title of the scheduled job.
          maxLength: 100
          minLength: 1
          title: Title
          type: string
      required:
      - notebookId
      title: CreateManualRunRequest
      type: object
    CreateMemorySpaceRequest:
      description: Request body for creating a Memory Space
      properties:
        customInstructions:
          anyOf:
          - maxLength: 10000
            type: string
          - type: 'null'
          description: Custom prompt instructions used for fact extraction Null leaves
            mem0 on its default extraction prompt.
          title: Custominstructions
        description:
          anyOf:
          - maxLength: 1000
            type: string
          - type: 'null'
          description: Optional description for the memory space.
          title: Description
        llmBaseUrl:
          anyOf:
          - format: uri
            maxLength: 2083
            minLength: 1
            type: string
          - type: 'null'
          description: Chat API URL to use for memory extraction.
          title: Llmbaseurl
        llmModelName:
          anyOf:
          - maxLength: 200
            type: string
          - type: 'null'
          description: Name of the LLM model to use for memory extraction. Non-reasoning
            models such as ``gpt-4o`` are recommended. Reasoning-capable models are
            significantly slower for fact extraction without producing meaningfully
            better results.
          title: Llmmodelname
      title: CreateMemorySpaceRequest
      type: object
    CreateNotebookCellSchema:
      description: The schema for the notebook cell to be created.
      properties:
        cellType:
          allOf:
          - $ref: '#/components/schemas/SupportedCellTypes'
          description: Type of the cell to create.
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: Metadata of the cell.
          title: Metadata
        source:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          description: Contents of the cell, represented as a string.
          title: Source
      required:
      - cellType
      title: CreateNotebookCellSchema
      type: object
    CreateNotebookRequest:
      description: Request schema for creating a notebook.
      properties:
        createInitialCell:
          default: true
          description: Whether to create an initial cell.
          title: Createinitialcell
          type: boolean
        description:
          description: The description of the notebook.
          title: Description
          type: string
        name:
          default: Untitled Notebook
          description: The name of the notebook.
          title: Name
          type: string
        settings:
          allOf:
          - $ref: '#/components/schemas/NotebookSettings'
          default:
            hide_cell_footers: false
            hide_cell_outputs: false
            hide_cell_titles: false
            highlight_whitespace: false
            show_line_numbers: false
            show_scrollers: false
          description: The settings of the notebook.
          title: Settings
        tags:
          description: The tags of the notebook.
          items:
            type: string
          title: Tags
          type: array
        type:
          allOf:
          - $ref: '#/components/schemas/NotebookType'
          default: plain
          description: The type of the notebook.
        typeTransition:
          allOf:
          - $ref: '#/components/schemas/NotebookTypeTransition'
          description: The type transition of the notebook.
        useCaseId:
          description: The ID of the Use Case associated with the notebook.
          title: Usecaseid
          type: string
        useCaseName:
          description: The name of the Use Case associated with the notebook.
          title: Usecasename
          type: string
      title: CreateNotebookRequest
      type: object
    CreateNotebookRevisionRequest:
      description: Request to create a new notebook revision.
      properties:
        isAuto:
          default: false
          description: Whether the revision is autosaved.
          title: Isauto
          type: boolean
        name:
          description: Notebook revision name.
          minLength: 1
          title: Name
          type: string
        notebookPath:
          description: Path to the notebook file, if using Codespaces.
          title: Notebookpath
          type: string
      title: CreateNotebookRevisionRequest
      type: object
    CreateOOTBMetricConfigurationsRequest:
      description: The body of the "Create OOTB metric configurations" request.
      properties:
        ootbMetricConfigurations:
          description: The list of OOTB metrics to use.
          items:
            $ref: '#/components/schemas/OOTBMetricConfigurationRequest'
          title: ootbMetricConfigurations
          type: array
      required:
      - ootbMetricConfigurations
      title: CreateOOTBMetricConfigurationsRequest
      type: object
    CreatePlaygroundRequest:
      description: The body of the Create Playground request.
      properties:
        copyInsights:
          anyOf:
          - $ref: '#/components/schemas/CopyInsightsRequest'
          - type: 'null'
          description: If present, copy insights from source playground to the created
            playground.
        description:
          description: The description of the playground.
          maxLength: 5000
          title: description
          type: string
        name:
          description: The name of the playground.
          maxLength: 5000
          title: name
          type: string
        playgroundType:
          $ref: '#/components/schemas/PlaygroundType'
          default: rag
          description: The type of the playground.
        useCaseId:
          description: The ID of the use case to link the playground to.
          title: useCaseId
          type: string
      required:
      - useCaseId
      - name
      - description
      title: CreatePlaygroundRequest
      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. The 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
    CreatePromptTemplateRequest:
      description: The body of the Create PromptTemplate request.
      properties:
        description:
          description: New prompt template description.
          maxLength: 5000
          title: description
          type: string
        name:
          description: New prompt template name.
          maxLength: 5000
          title: name
          type: string
      required:
      - name
      - description
      title: CreatePromptTemplateRequest
      type: object
    CreatePromptTemplateVersionRequest:
      description: The body of the Create PromptTemplateVersion request.
      properties:
        commitComment:
          description: Description of changes for this prompt template version.
          maxLength: 5000
          title: commitComment
          type: string
        promptText:
          description: The text of the prompt with variables enclosed in double curly
            brackets.
          maxLength: 5000000
          title: promptText
          type: string
        variables:
          description: Variables for this prompt.
          items:
            $ref: '#/components/schemas/Variable'
          maxItems: 100
          title: variables
          type: array
      required:
      - promptText
      - commitComment
      - variables
      title: CreatePromptTemplateVersionRequest
      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
    CreateScheduledJobRequest:
      description: Request to create a new scheduled job.
      properties:
        enabled:
          default: true
          description: Whether the job is enabled.
          title: Enabled
          type: boolean
        notebookId:
          description: The ID of the notebook to schedule.
          title: Notebookid
          type: string
        notebookPath:
          description: The path to the notebook in the file system if a Codespace
            is being used.
          title: Notebookpath
          type: string
        parameters:
          description: The parameters to pass to the notebook when it runs.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
        schedule:
          allOf:
          - $ref: '#/components/schemas/Schedule'
          description: The schedule for the job.
          title: Schedule
        title:
          description: The title of the scheduled job.
          maxLength: 100
          minLength: 1
          title: Title
          type: string
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      required:
      - useCaseId
      - notebookId
      - schedule
      title: CreateScheduledJobRequest
      type: object
    CreateSessionRequest:
      description: Request to create a new session with optional lifecycle strategies.
      example:
        description: Customer support conversation
        lifecycleStrategies:
        - trigger:
            ttl: 604800
          type: soft_delete
        metadata:
          department: sales
          priority: high
          region: us-east
        participants:
        - 507f1f77bcf86cd799439011
      properties:
        deduplicationKey:
          anyOf:
          - maxLength: 72
            minLength: 1
            type: string
          - type: 'null'
          description: Optional key, unique within the memory space, for idempotent
            session creation by coordinating HA agents. A second create with the same
            key returns 409.
          title: Deduplicationkey
        description:
          anyOf:
          - maxLength: 1000
            type: string
          - type: 'null'
          description: Optional session description
          title: Description
        lifecycleStrategies:
          description: Lifecycle strategies that automatically manage session lifecycle
          items:
            $ref: '#/components/schemas/LifecycleStrategiesDataModel'
          maxItems: 5
          title: Lifecyclestrategies
          type: array
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Custom metadata as key-value pairs for storing application-specific
            data
          title: Metadata
        participants:
          description: List of participant IDs (ObjectId format)
          items:
            type: string
          maxItems: 1
          minItems: 1
          title: Participants
          type: array
      required:
      - participants
      - lifecycleStrategies
      title: CreateSessionRequest
      type: object
    CreateShapMatrixPayload:
      properties:
        datasetId:
          description: The dataset ID.
          type: string
        modelId:
          description: The model ID.
          type: string
      required:
      - datasetId
      - modelId
      type: object
    CreateSidecarModelMetricValidationRequest:
      description: The body of the "Validate sidecar model metric" request.
      properties:
        citationsPrefixColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The column name prefix the custom model uses for citation inputs.
          title: citationsPrefixColumnName
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        expectedResponseColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the column the custom model uses for the expected
            response text input.
          title: expectedResponseColumnName
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the model used in the deployment.
          title: modelId
        moderationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration to be associated with the sidecar
            model metric.
        name:
          default: Untitled
          description: The name to use for the validated custom model.
          maxLength: 5000
          title: name
          type: string
        playgroundId:
          description: The ID of the playground to associate with the validated custom
            model.
          title: playgroundId
          type: string
        predictionTimeout:
          default: 300
          description: The timeout in seconds for the prediction when validating a
            custom model. Defaults to 300.
          maximum: 600.0
          minimum: 1.0
          title: predictionTimeout
          type: integer
        promptColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the column the custom model uses for prompt text
            input.
          title: promptColumnName
        responseColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the column the custom model uses for response text
            input.
          title: responseColumnName
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          maxLength: 5000
          title: targetColumnName
          type: string
        useCaseId:
          description: The ID of the use case to associate with the validated custom
            model.
          title: useCaseId
          type: string
      required:
      - deploymentId
      - useCaseId
      - playgroundId
      - targetColumnName
      title: CreateSidecarModelMetricValidationRequest
      type: object
    CreateSsoConfiguration:
      properties:
        attributeMapping:
          $ref: '#/components/schemas/EnhancedSamlAttributeMapping'
        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'
        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'
          maxItems: 100
          type: array
        idpMetadata:
          $ref: '#/components/schemas/SamlMetadataFile'
        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
        organizationMapping:
          description: The list of DataRobot organization to identity provider organization
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlOrganizationMapping'
          maxItems: 100
          type: array
          x-versionadded: v2.37
        roleMapping:
          description: The list of DataRobot access role to identity provider role
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlRoleMapping'
          maxItems: 100
          type: array
        securityParameters:
          $ref: '#/components/schemas/SamlSecurityParameters'
        sessionLengthSeconds:
          default: 604800
          description: Time window for the authentication session via IDP
          exclusiveMinimum: 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
    CreateTerminalSchema:
      description: Schema for creating a terminal.
      properties:
        name:
          description: Name of the terminal.
          title: Name
          type: string
      required:
      - name
      title: CreateTerminalSchema
      type: object
    CreateTraceDatasetRequest:
      description: The body of the Create Playground request.
      properties:
        excludeTracesWithWarnings:
          default: true
          description: Whether to exclude traces with warnings.
          title: excludeTracesWithWarnings
          type: boolean
      title: CreateTraceDatasetRequest
      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: The array of attachment objects.
          items:
            $ref: '#/components/schemas/ValueTrackerAttachment'
          type: array
      required:
      - attachedObjects
      type: object
    CreateVectorDatabaseCustomModelVersionRequest:
      description: The body of the "Create custom model version" request.
      properties:
        modelName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the custom model that this job will create.
          title: modelName
        promptColumnName:
          default: promptText
          description: The name of the column to use for prompt text input in the
            custom model.
          maxLength: 5000
          title: promptColumnName
          type: string
        resources:
          anyOf:
          - $ref: '#/components/schemas/CustomModelResourcesRequest'
          - type: 'null'
          description: The resources that the custom model will be provisioned with.
        targetColumnName:
          default: relevant
          description: The name of the column to use for prediction output in the
            custom model.
          maxLength: 5000
          title: targetColumnName
          type: string
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database linked to this LLM blueprint.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettingsRequest'
          - type: 'null'
          description: A key/value dictionary of vector database settings.
      title: CreateVectorDatabaseCustomModelVersionRequest
      type: object
    CreateVectorDatabaseDeploymentRequest:
      description: The body of the "Create vector database deployment" request.
      properties:
        credentialId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the credential to access the connected vector database.
          title: credentialId
        defaultPredictionServerId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of a prediction server for the new deployment to use.
            Cannot be used with predictionEnvironmentId.
          title: defaultPredictionServerId
        modelName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name of the custom model that this job will create.
          title: modelName
        predictionEnvironmentId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the prediction environment for the new deployment
            to use. Cannot be used with defaultPredictionServerId.
          title: predictionEnvironmentId
        promptColumnName:
          default: promptText
          description: The name of the column to use for prompt text input in the
            custom model.
          maxLength: 5000
          title: promptColumnName
          type: string
        resources:
          anyOf:
          - $ref: '#/components/schemas/CustomModelResourcesRequest'
          - type: 'null'
          description: The resources that the custom model will be provisioned with.
        targetColumnName:
          default: relevant
          description: The name of the column to use for prediction output in the
            custom model.
          maxLength: 5000
          title: targetColumnName
          type: string
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database linked to this LLM blueprint.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettingsRequest'
          - type: 'null'
          description: A key/value dictionary of vector database settings.
      title: CreateVectorDatabaseDeploymentRequest
      type: object
    CreateVectorDatabaseDeploymentResponse:
      description: The response to the "Create vector database deployment" request.
      properties:
        jobId:
          description: The ID of the job that will create the new vector database
            deployment.
          format: uuid4
          title: jobId
          type: string
      required:
      - jobId
      title: CreateVectorDatabaseDeploymentResponse
      type: object
    CreateVectorDatabaseRequest:
      description: The body of the "Create vector database" request.
      properties:
        chunkingParameters:
          anyOf:
          - $ref: '#/components/schemas/ChunkingParameters'
          - type: 'null'
          description: The text chunking parameters to use for building the vector
            database.
        datasetId:
          description: The ID of the dataset to use for building the vector database.
          title: datasetId
          type: string
        externalVectorDatabaseConnection:
          anyOf:
          - discriminator:
              mapping:
                elasticsearch: '#/components/schemas/ElasticsearchConnectionRequest'
                milvus: '#/components/schemas/MilvusConnectionRequest'
                pinecone: '#/components/schemas/PineconeConnectionRequest'
                postgres: '#/components/schemas/PostgresConnectionRequest'
              propertyName: type
            oneOf:
            - $ref: '#/components/schemas/PineconeConnectionRequest'
            - $ref: '#/components/schemas/ElasticsearchConnectionRequest'
            - $ref: '#/components/schemas/MilvusConnectionRequest'
            - $ref: '#/components/schemas/PostgresConnectionRequest'
          - type: 'null'
          description: The external vector database connection to use.
          title: externalVectorDatabaseConnection
        metadataCombinationStrategy:
          $ref: '#/components/schemas/MetadataCombinationStrategy'
          default: replace
          description: The strategy to use when the dataset and the metadata file
            have duplicate columns.
        metadataDatasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the dataset to add metadata for building the vector
            database.
          title: metadataDatasetId
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The name of the vector database.
          title: name
        parentVectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the parent vector database used as base for the re-building.
          title: parentVectorDatabaseId
        updateDeployments:
          default: false
          description: Whether to update the deployments that use the parent vector
            database.Can only be set to `true` if parent_vector_database_id is provided.
          title: updateDeployments
          type: boolean
        updateLlmBlueprints:
          default: false
          description: Whether to update the LLM blueprints that use the parent vector
            database.Can only be set to `true` if parent_vector_database_id is provided.
          title: updateLlmBlueprints
          type: boolean
        useCaseId:
          description: The ID of the use case to link the vector database to.
          title: useCaseId
          type: string
      required:
      - datasetId
      - useCaseId
      title: CreateVectorDatabaseRequest
      type: object
    CreateWorkloadRequest:
      additionalProperties: false
      description: Request to create a new workload.
      properties:
        artifact:
          anyOf:
          - $ref: '#/components/schemas/InputArtifact'
          - type: 'null'
          description: Inline artifact spec to create and deploy in one step
          title: Artifact
        artifactId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of an existing artifact to deploy
          title: Artifact ID
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Workload description
          title: Description
        importance:
          $ref: '#/components/schemas/WorkloadImportance'
          default: low
          description: Workload importance level
          title: Importance
        name:
          description: Workload name
          maxLength: 5000
          minLength: 1
          title: Name
          type: string
        runtime:
          $ref: '#/components/schemas/WorkloadRuntime'
          description: Runtime configuration
          title: Runtime
      required:
      - name
      title: CreateWorkloadRequest
      type: object
    CreateWorkspaceState:
      properties:
        datasets:
          description: The source datasets in the data engine workspace.
          items:
            $ref: '#/components/schemas/DataEngineDataset'
          type: array
        language:
          description: The language of the data engine query.
          enum:
          - SQL
          type: string
        query:
          description: The actual body of the data engine query.
          maxLength: 320000
          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:
      description: User that created template.
      properties:
        firstName:
          description: First Name.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        lastName:
          description: Last Name.
          type:
          - string
          - 'null'
          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: The ID of the output dataset item.
          type: string
        datasetVersionId:
          description: The 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
    CreatedFilesResponse:
      properties:
        catalogId:
          description: The ID of the catalog entry.
          type: string
        catalogVersionId:
          description: The ID of the catalog entry version.
          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
      x-versionadded: v2.37
    CreatedLinksResponse:
      properties:
        links:
          description: The list of generated links
          items:
            $ref: '#/components/schemas/Link'
          maxItems: 100
          type: array
      required:
      - links
      type: object
      x-versionadded: v2.37
    CredentialEnvironmentVariable:
      properties:
        drCredentialId:
          description: ID of the DataRobot credential to use
          title: DR Credential ID
          type: string
        key:
          description: Key within the credential
          title: Key
          type: string
        name:
          description: Name of the environment variable
          title: Name
          type: string
        source:
          const: dr-credential
          title: Source
          type: string
      required:
      - source
      - name
      - drCredentialId
      - key
      title: CredentialEnvironmentVariable
      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
          type:
          - string
          - 'null'
        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: The credential type.
            enum:
            - basic
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          password:
            description: Password to store for these credentials.
            type: string
          snowflakeAccountName:
            description: Snowflake account name.
            type: string
            x-versionadded: v2.21
          user:
            description: Username to store for these credentials.
            type: string
        required:
        - name
        - password
        - user
        type: object
      - properties:
          credentialType:
            description: The credential type.
            enum:
            - oauth
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          refreshToken:
            description: OAUTH refresh token.
            type: string
          token:
            description: OAUTH token.
            type: string
        required:
        - credentialType
        - name
        - refreshToken
        - token
        type: object
      - 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
            x-versionadded: v2.20
          awsSecretAccessKey:
            description: The S3 AWS secret access key. Required if configId is not
              specified.Cannot include this parameter if configId is specified.
            type: string
            x-versionadded: v2.20
          awsSessionToken:
            default: null
            description: The S3 AWS session token for AWS temporary credentials.Cannot
              include this parameter if configId is specified.
            type:
            - string
            - 'null'
            x-versionadded: v2.20
          configId:
            description: The ID of secure configurations of credentials shared by
              admin. If specified, cannot include awsAccessKeyId, awsSecretAccessKey
              or awsSessionToken.
            type: string
            x-versionadded: v2.32
          credentialType:
            description: The type of these credentials, 's3' here.
            enum:
            - s3
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          configId:
            description: The ID of secure configurations shared by admin. Alternative
              to googleConfigId (deprecated). If specified, cannot include gcpKey.
            type: string
            x-versionadded: v2.32
          credentialType:
            description: The type of these credentials, 'gcp' here.
            enum:
            - gcp
            type: string
          description:
            description: Credentials description.
            type: string
          gcpKey:
            $ref: '#/components/schemas/GCPKey'
            x-versionadded: v2.21
          googleConfigId:
            description: The ID of secure configurations shared by admin. This is
              deprecated. Please use configId instead. If specified, cannot include
              gcpKey.
            type: string
            x-versionadded: v2.30
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          azureConnectionString:
            description: The Azure connection string.
            type: string
            x-versionadded: v2.21
          credentialType:
            description: The type of these credentials, 'azure' here.
            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
          configId:
            description: The ID of the secure configuration to share Azure service
              principal credentials by admin.
            type: string
            x-versionadded: v2.35
          credentialType:
            description: The type of these credentials, 'azure_service_principal'
              here.
            enum:
            - azure_service_principal
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - 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: The credential 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
          configId:
            description: ID of secure configuration to share ADLS OAuth credentials
              by admin.
            type: string
            x-versionadded: v2.35
          credentialType:
            description: The credential 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:
        - credentialType
        - name
        type: object
      - properties:
          clientId:
            description: Azure OAuth client ID.
            type: string
            x-versionadded: v2.38
          clientSecret:
            description: Azure OAuth client secret.
            type: string
            x-versionadded: v2.38
          credentialType:
            description: The credential type.
            enum:
            - azure_oauth
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          oauthScopes:
            description: Azure OAuth scopes.
            items:
              description: Azure OAuth scope.
              type: string
            maxItems: 100
            minItems: 1
            type: array
            x-versionadded: v2.38
        required:
        - clientId
        - clientSecret
        - credentialType
        - name
        - oauthScopes
        type: object
      - properties:
          authenticationId:
            description: The authentication ID for an external OAuth provider. Used
              to retrieve tokens from DataRobot OAuth service.
            type: string
          credentialType:
            description: The type of these credentials, 'external_oauth_provider'
              here.
            enum:
            - external_oauth_provider
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - authenticationId
        - credentialType
        - name
        type: object
      - properties:
          configId:
            description: The ID of the saved shared credentials. If specified, cannot
              include user, privateKeyStr, or passphrase.
            type: string
            x-versionadded: v2.32
          credentialType:
            description: The type of these credentials, 'snowflake_key_pair_user_account'
              here.
            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 decrypt private key. Cannot include
              this parameter if configId is specified.
            minLength: 1
            type: string
            x-versionadded: v2.30
          privateKeyStr:
            description: Private key for key pair authentication. Required if configId
              is not specified. This cannot be included if configId is specified.
            minLength: 1
            type: string
            x-versionadded: v2.30
          user:
            description: Username for this credential. Required if configId is not
              specified. This cannot be included if configId is specified.
            type: string
        required:
        - credentialType
        - name
        type: object
      - 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
            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.
            minLength: 1
            type: string
            x-versionadded: v2.33
          clientSecret:
            description: Client secret for Databricks service principal.
            minLength: 1
            type: string
            x-versionadded: v2.33
          configId:
            description: The ID of the saved shared credentials. If specified, cannot
              include clientId and clientSecret.
            type: string
            x-versionadded: v2.33
          credentialType:
            description: The type of these credentials, 'databricks_service_principal_account'
              here.
            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: The credential type.
            enum:
            - api_token
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - apiToken
        - credentialType
        - name
        type: object
      - properties:
          authUrl:
            description: The URL used for SAP authentication.
            format: uri
            type: string
            x-versionadded: v2.35
          clientId:
            description: SAP OAUTH client ID.
            type: string
            x-versionadded: v2.35
          clientSecret:
            description: SAP OAUTH client secret.
            type: string
            x-versionadded: v2.35
          credentialType:
            description: The credential type.
            enum:
            - sap_oauth
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          sapAiApiUrl:
            description: The URL used for SAP AI API service.
            format: uri
            type: string
            x-versionadded: v2.35
        required:
        - authUrl
        - clientId
        - clientSecret
        - credentialType
        - name
        - sapAiApiUrl
        type: object
      - properties:
          clientId:
            description: Box JWT client ID.
            type: string
            x-versionadded: v2.41
          clientSecret:
            description: Box JWT client secret.
            type: string
            x-versionadded: v2.41
          configId:
            description: ID of secure configuration to share Box JWT credentials by
              admin.
            type: string
            x-versionadded: v2.41
          credentialType:
            description: The credential type.
            enum:
            - box_jwt
            type: string
            x-versionadded: v2.41
          description:
            description: Credentials description.
            type: string
          enterpriseId:
            description: Box enterprise identifier.
            type: string
            x-versionadded: v2.41
          name:
            description: Credentials name.
            type: string
          passphrase:
            description: Passphrase for the Box JWT private key.
            minLength: 1
            type: string
            x-versionadded: v2.41
          privateKeyStr:
            description: RSA private key for Box JWT.
            minLength: 1
            type: string
            x-versionadded: v2.41
          publicKeyId:
            description: Box public key identifier.
            type: string
            x-versionadded: v2.41
        required:
        - credentialType
        - name
        type: object
      - properties:
          clientId:
            description: The client ID for integrations that use a client ID and client
              secret (e.g., OAuth client credentials).
            type: string
            x-versionadded: v2.42
          clientSecret:
            description: The client secret for integrations that use a client ID and
              client secret (e.g., OAuth client credentials).
            type: string
            x-versionadded: v2.42
          configId:
            description: The ID of the shared secure configuration for the client
              ID and client secret (managed by an admin).
            type: string
            x-versionadded: v2.42
          credentialType:
            description: The credential type.
            enum:
            - client_id_and_secret
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
        required:
        - credentialType
        - name
        type: object
      - properties:
          credentialType:
            description: The type of these credentials, 'azure_sas' here.
            enum:
            - azure_sas
            type: string
          description:
            description: Credentials description.
            type: string
          name:
            description: Credentials name.
            type: string
          sasToken:
            description: The Azure shared access signature (SAS) token for Data Lake
              Storage Gen2.
            minLength: 1
            type: string
        required:
        - credentialType
        - name
        - sasToken
        type: object
    CredentialsListAssociationsResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CredentialsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of credentials.
          items:
            $ref: '#/components/schemas/CreateCredentialsResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
        authUrl:
          description: The URL used for SAP OAuth authentication.
          format: uri
          type: string
          x-versionadded: v2.35
        authenticationId:
          description: Authorized external OAuth provider identifier.
          type: string
          x-versionadded: v2.41
        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`, `sap_oauth_account`, `azure_service_principal`, `azure_oauth`
            and `client_id_and_secret`).
          type: string
          x-versionadded: v2.23
        clientSecret:
          description: OAUTH client secret (applicable for credentialType `snowflake_oauth_user_account`,
            `adls_gen2_oauth`, `sap_oauth_account`, `azure_service_principal`, `azure_oauth`
            and `client_id_and_secret`).
          type: string
          x-versionadded: v2.23
        configId:
          description: ID of secure configuration credentials to share 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
        enterpriseId:
          description: Box enterprise identifier (applicable for credentialType `box_jwt`
            only).
          type: string
          x-versionadded: v2.41
        gcpKey:
          $ref: '#/components/schemas/GCPKey'
          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, credentialType `snowflake_oauth_user_account`, `adls_gen2_oauth`,
            and `azure_oauth`).
          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
        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
        publicKeyId:
          description: Box public key identifier (applicable for credentialType `box_jwt`
            only).
          type: string
          x-versionadded: v2.41
        refreshToken:
          description: OAUTH refresh token (applicable for credentialType `oauth`
            only).
          type: string
        sapAiApiUrl:
          description: The URL used for SAP AI API service.
          format: uri
          type: string
          x-versionadded: v2.35
        sasToken:
          description: The Azure SAS token (only applicable for credentialType `azure_sas`).
          type: string
          x-versionadded: v2.45
        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
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
    CustomAppHistory:
      properties:
        createdAt:
          description: The date and time that the user published a new version of
            the app.
          format: date-time
          type: string
        createdBy:
          description: The username of the user who published the application.
          type:
          - string
          - 'null'
        creatorFirstName:
          description: The first name of the user who published the application.
          type:
          - string
          - 'null'
        creatorLastName:
          description: The last name of the user who published the application.
          type:
          - string
          - 'null'
        creatorUserhash:
          description: The Gravatar hash of the user who published the application.
          type:
          - string
          - 'null'
        sourceId:
          description: The custom application source ID of the record.
          type: string
        sourceName:
          description: The name of the custom app source.
          type: string
        sourceVersionId:
          description: The custom application source version ID of the record.
          type: string
        sourceVersionLabel:
          description: The label of the source version.
          type: string
      required:
      - createdAt
      - sourceId
      - sourceVersionId
      type: object
      x-versionadded: v2.37
    CustomAppUsage:
      properties:
        userId:
          description: The ID of the user (or null for a guest).
          type:
          - string
          - 'null'
        userType:
          description: Determines whether the user was a creator, viewer, or guest
            at the time of visit.
          enum:
          - guest
          - viewer
          - creator
          type:
          - string
          - 'null'
        username:
          description: The name of the user.
          maxLength: 512
          minLength: 1
          type: string
        visitTimestamp:
          description: The date and time that user last visited the app.
          format: date-time
          type: string
      required:
      - userId
      - userType
      - username
      - visitTimestamp
      type: object
      x-versionadded: v2.37
    CustomApplication:
      properties:
        allowAutoStopping:
          description: Determines if apps are auto-paused to save resources.
          type:
          - boolean
          - 'null'
        applicationUrl:
          description: The URL for accessing application endpoints
          format: uri
          type:
          - string
          - 'null'
        createdAt:
          description: The timestamp when the application was created.
          type: string
        createdBy:
          description: The username of who created the application
          type:
          - string
          - 'null'
        creatorFirstName:
          description: The first name of who created the application
          type:
          - string
          - 'null'
        creatorLastName:
          description: The last name of who created the application
          type:
          - string
          - 'null'
        creatorUserhash:
          description: The Gravatar hash of user who created the application
          type:
          - string
          - 'null'
        customApplicationSourceId:
          description: The custom application source used in app.
          type:
          - string
          - 'null'
        customApplicationSourceVersionId:
          description: The custom application source version used in app.
          type:
          - string
          - 'null'
        envVersionId:
          description: The execution environment version used in app
          type:
          - string
          - 'null'
        expiresAt:
          description: ISO-8601 formatted date of the custom application removing
            date
          format: date-time
          type:
          - string
          - 'null'
        externalAccessEnabled:
          description: Determines if sharing with guest users is allowed.
          type:
          - boolean
          - 'null'
        externalAccessRecipients:
          description: The external users and domains allowed to view this app.
          items:
            type: string
          maxItems: 100
          type: array
        id:
          description: The custom application ID.
          type: string
        lrsId:
          description: The Long Running Service ID associated with app.
          type:
          - string
          - 'null'
          x-versionadded: v2.38
        name:
          description: The name of the custom application.
          maxLength: 512
          minLength: 1
          type: string
        orgId:
          description: The ID of the creator's organization.
          type:
          - string
          - 'null'
        permissions:
          description: The list of permitted actions, which the authenticated user
            can perform on this application.
          items:
            enum:
            - CAN_CHANGE_EXTERNAL_ACCESS
            - CAN_DELETE
            - CAN_PUBLISH_NEW_IMAGE
            - CAN_SEE_SOURCE
            - CAN_SHARE
            - CAN_UPDATE
            - CAN_VIEW
            type: string
          maxItems: 100
          type: array
        resources:
          $ref: '#/components/schemas/CustomApplicationResourcesResponse'
          x-versionadded: v2.37
        sourceName:
          description: The name of the custom app source.
          type: string
        sourceVersionLabel:
          description: The label of the source version.
          type: string
        status:
          description: The state of application in LRS
          enum:
          - created
          - failed
          - initializing
          - paused
          - publishing
          - running
          type: string
        updatedAt:
          description: The timestamp when the application was updated.
          type: string
        userId:
          description: Creator's ID
          type: string
      required:
      - allowAutoStopping
      - applicationUrl
      - createdAt
      - customApplicationSourceId
      - customApplicationSourceVersionId
      - envVersionId
      - expiresAt
      - externalAccessEnabled
      - externalAccessRecipients
      - id
      - lrsId
      - name
      - orgId
      - permissions
      - status
      - updatedAt
      - userId
      type: object
      x-versionadded: v2.37
    CustomApplicationCreate:
      properties:
        applicationSourceId:
          description: The ID of the custom application source to be used for the
            new application. The latest version version will be chosen.
          type: string
        applicationSourceVersionId:
          description: The ID of the custom application source version to be used
            for the new application.
          type: string
        environmentId:
          description: The execution environment ID for the application.
          type: string
        name:
          description: The name of the custom application.
          maxLength: 512
          type:
          - string
          - 'null'
        resources:
          $ref: '#/components/schemas/CustomApplicationResources'
      type: object
      x-versionadded: v2.37
    CustomApplicationItemRetrieve:
      properties:
        content:
          description: The textual content of the file item.
          type: string
        fileName:
          description: The name of the file item.
          type: string
        filePath:
          description: The full internal path of the file item.
          type: string
        id:
          description: The ID of the file item.
          type: string
      required:
      - content
      - fileName
      - filePath
      - id
      type: object
      x-versionadded: v2.37
    CustomApplicationListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The array of custom application objects.
          items:
            $ref: '#/components/schemas/CustomApplication'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    CustomApplicationLogs:
      properties:
        buildError:
          description: The build error of the custom application.
          type: string
        buildLog:
          description: The build log of the custom application.
          type: string
        buildStatus:
          description: The build status of the custom application.
          type: string
        logs:
          description: The logs of the custom application.
          items:
            type: string
          maxItems: 1000
          type: array
      required:
      - logs
      type: object
      x-versionadded: v2.37
    CustomApplicationResources:
      description: Resources required for running custom application.
      properties:
        healthEndpointPath:
          description: The path used by the Kubernetes health probe for liveness and
            readiness checks. When set, this takes precedence over the path derived
            from `serviceWebRequestsOnRootPath`. Use this to expose a dedicated health
            endpoint (e.g., `/healthz`) instead of probing the root path.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.43
        replicas:
          description: The number of running application replicas.
          minimum: 0
          type: integer
        resourceLabel:
          description: The ID of the resource request bundle used for custom application.
          type: string
        serviceWebRequestsOnRootPath:
          description: Sets whether applications made from this source version expect
            to receive requests on `/` or on `/apps/{ID}` by default.
          type:
          - boolean
          - 'null'
        sessionAffinity:
          description: The Session affinity of an application source version.
          type:
          - boolean
          - 'null'
      type: object
      x-versionadded: v2.37
    CustomApplicationResourcesResponse:
      description: The resource configuration for the application, including CPU,
        memory, replicas, etc.
      properties:
        cpuLimit:
          description: The CPU core limit for a container.
          type: number
        cpuRequest:
          description: The requested CPU cores for a container.
          type: number
        healthEndpointPath:
          description: The path used by the Kubernetes health probe for liveness and
            readiness checks. When set, this takes precedence over the path derived
            from `serviceWebRequestsOnRootPath`. Use this to expose a dedicated health
            endpoint (e.g., `/healthz`) instead of probing the root path.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.43
        memoryLimit:
          description: The memory limit for a container in bytes.
          type: integer
        memoryRequest:
          description: The requested memory for a container in bytes.
          type: integer
        replicas:
          description: The number of running application replicas.
          type: integer
        resourceLabel:
          description: The ID of the resource request bundle used for custom application.
          type: string
        serviceWebRequestsOnRootPath:
          description: Sets whether applications made from this source version expect
            to receive requests on `/` or on `/apps/{ID}` by default.
          type: boolean
        sessionAffinity:
          description: The session affinity for an application.
          type: boolean
        storageLimit:
          description: The ephemeral storage limit for a container in bytes.
          type: integer
          x-versionadded: v2.42
        storageRequest:
          description: The requested ephemeral storage for a container in bytes.
          type: integer
          x-versionadded: v2.42
      required:
      - cpuLimit
      - cpuRequest
      - healthEndpointPath
      - memoryLimit
      - memoryRequest
      - replicas
      - resourceLabel
      - serviceWebRequestsOnRootPath
      - sessionAffinity
      - storageLimit
      - storageRequest
      type: object
      x-versionadded: v2.37
    CustomApplicationSource:
      properties:
        createdAt:
          description: The timestamp when the application source was created.
          type: string
        createdBy:
          description: The username of who created the application source.
          type:
          - string
          - 'null'
        creatorFirstName:
          description: The first name of who created the application source.
          type:
          - string
          - 'null'
        creatorLastName:
          description: The last name of who created the application source.
          type:
          - string
          - 'null'
        creatorUserhash:
          description: The Gravatar hash of user who created the application source.
          type:
          - string
          - 'null'
        id:
          description: The custom application source ID.
          type: string
        latestVersion:
          $ref: '#/components/schemas/CustomApplicationSourceVersion'
        name:
          description: The name of the custom application source.
          maxLength: 255
          minLength: 1
          type: string
        orgId:
          description: The ID of the creator's organization.
          type:
          - string
          - 'null'
        permissions:
          description: The list of permitted actions, which the authenticated user
            can perform on this application source.
          items:
            enum:
            - CAN_PUBLISH_NEW_IMAGE
            - CAN_CHANGE_EXTERNAL_ACCESS
            - CAN_VIEW
            - CAN_UPDATE
            - CAN_DELETE
            - CAN_SHARE
            type: string
          maxItems: 100
          type: array
        updatedAt:
          description: The timestamp when the application source was modified.
          type: string
        userId:
          description: Creator's ID.
          type: string
      required:
      - createdAt
      - id
      - latestVersion
      - name
      - orgId
      - permissions
      - updatedAt
      - userId
      type: object
      x-versionadded: v2.35
    CustomApplicationSourceCreate:
      properties:
        name:
          description: The name of the custom application source.
          maxLength: 255
          minLength: 1
          type: string
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceFromGalleryTemplateCreate:
      properties:
        customTemplateId:
          description: The custom template ID for the custom application.
          type: string
      required:
      - customTemplateId
      type: object
      x-versionadded: v2.35
    CustomApplicationSourceListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The array of custom application source objects.
          items:
            $ref: '#/components/schemas/CustomApplicationSource'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceUpdate:
      properties:
        name:
          description: The name of the custom application source.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - name
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceVersion:
      description: The latest version of the source.
      properties:
        baseEnvironmentId:
          description: The ID of the environment used for this source.
          type:
          - string
          - 'null'
        baseEnvironmentVersionId:
          description: The ID of the environment version used for this source.
          type:
          - string
          - 'null'
        createdAt:
          description: The timestamp of when the application source version was created.
          type: string
        createdBy:
          description: The username of who created the application source version.
          type:
          - string
          - 'null'
        creatorFirstName:
          description: The first name of who created the application source version.
          type:
          - string
          - 'null'
        creatorLastName:
          description: The last name of who created the application source version.
          type:
          - string
          - 'null'
        creatorUserhash:
          description: The Gravatar hash of user who created the application source
            version.
          type:
          - string
          - 'null'
        id:
          description: The custom application source version ID.
          type: string
        isFrozen:
          description: Marks that this version has become immutable.
          type: boolean
        items:
          description: The list of file items.
          items:
            $ref: '#/components/schemas/WorkspaceItemResponse'
          maxItems: 1000
          type: array
        label:
          description: The label of the custom application source version.
          maxLength: 255
          minLength: 1
          type:
          - string
          - 'null'
        updatedAt:
          description: The timestamp when the application source version was modified.
          type: string
        userId:
          description: Creator's ID.
          type: string
      required:
      - baseEnvironmentId
      - baseEnvironmentVersionId
      - createdAt
      - id
      - isFrozen
      - items
      - label
      - updatedAt
      - userId
      type: object
      x-versionadded: v2.35
    CustomApplicationSourceVersionCreate:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this source version.
          type: string
        baseEnvironmentVersionId:
          description: The base environment version ID to use with this source version.
          type: string
        baseVersion:
          description: The ID of the version used as the source for parameter duplication.
          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
            maxItems: 1000
            type: array
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 1000
            type: array
        label:
          description: The label for new Custom App Source Version.
          maxLength: 255
          minLength: 1
          type: string
        runtimeParameters:
          description: Full snapshot of runtime parameters to create or update. Send
            the complete desired state of all runtime parameters. Parameters present
            in payload but missing in version will be created. Parameters missing
            in payload but present in version will be deleted. Parameters present
            in both will be updated.
          type: string
          x-datarobot-public-preview: false
          x-datarobot-required-feature-flags:
          - description: Enables the addition of key-value pairs as Runtime-Parameters
              for Custom Inference Models.
            enabled_by_default: true
            maturity: GA_ALL
            name: CUSTOM_MODEL_RUNTIME_PARAMETERS
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceVersionFromCodespace:
      properties:
        codespaceId:
          description: The ID of the Codespace that should be used as source for files.
          type: string
        label:
          description: The label for new Custom App Source Version in case current
            version is frozen and new should be created.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - codespaceId
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceVersionFromCodespaceResponse:
      properties:
        id:
          description: The custom application source version ID.
          type: string
      required:
      - id
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceVersionListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array of custom application source version objects.
          items:
            $ref: '#/components/schemas/CustomApplicationSourceVersion'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceVersionToCodespace:
      properties:
        codespaceId:
          description: The ID of the Codespace that should be used as source for files.
          type: string
      required:
      - codespaceId
      type: object
      x-versionadded: v2.37
    CustomApplicationSourceVersionUpdate:
      properties:
        baseEnvironmentId:
          description: The base environment to use with this source version.
          type: string
        baseEnvironmentVersionId:
          description: The base environment version ID to use with this source 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
            maxItems: 1000
            type: array
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 1000
            type: array
        label:
          description: The label for new Custom App Source Version.
          maxLength: 255
          minLength: 1
          type: string
        runtimeParameters:
          description: Full snapshot of runtime parameters to create or update. Send
            the complete desired state of all runtime parameters. Parameters present
            in payload but missing in version will be created. Parameters missing
            in payload but present in version will be deleted. Parameters present
            in both will be updated.
          type: string
          x-datarobot-public-preview: false
          x-datarobot-required-feature-flags:
          - description: Enables the addition of key-value pairs as Runtime-Parameters
              for Custom Inference Models.
            enabled_by_default: true
            maturity: GA_ALL
            name: CUSTOM_MODEL_RUNTIME_PARAMETERS
      type: object
      x-versionadded: v2.37
    CustomApplicationUpdate:
      properties:
        allowAutoStopping:
          description: Determines if the custom app should be stopped automatically.
          type: boolean
        customApplicationSourceVersionId:
          description: The ID of the custom application source version to set this
            app to.
          type: string
        externalAccessEnabled:
          description: Determines if the custom app can be shared with guest users.
          type: boolean
        externalAccessRecipients:
          description: Who should be able to access the custom app
          items:
            description: The email address, or email domain of who can use an app
            maxLength: 512
            minLength: 0
            type: string
          maxItems: 2048
          type: array
        name:
          description: The name of the custom application.
          maxLength: 512
          minLength: 1
          type: string
      type: object
      x-versionadded: v2.37
    CustomApplicationsHistoryListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of custom application soure versions published to
            this custom application.
          items:
            $ref: '#/components/schemas/CustomAppHistory'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    CustomApplicationsUsagesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of visits to the custom application.
          items:
            $ref: '#/components/schemas/CustomAppUsage'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    CustomBoundaries:
      description: Null if default boundaries for the model are used
      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
    CustomEmbeddingModelNames:
      description: Model names for custom embedding models.
      enum:
      - custom-embeddings/default
      title: CustomEmbeddingModelNames
      type: string
    CustomJobCustomMetricUpdate:
      properties:
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        batch:
          $ref: '#/components/schemas/BatchField'
        categories:
          description: Category values. This field is required for categorical custom
            metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        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'
        schedule:
          $ref: '#/components/schemas/Schedule'
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type: string
        value:
          $ref: '#/components/schemas/ValueField'
      type: object
      x-versionadded: v2.34
    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
    CustomJobFromGalleryTemplateCreate:
      properties:
        description:
          default: ''
          description: Description of the hosted custom metric job.
          maxLength: 1000
          type: string
        name:
          description: Name of the hosted custom metric job.
          maxLength: 255
          type: string
        sidecarDeploymentId:
          description: Sidecar deployment ID.
          type: string
        templateId:
          description: Custom Metric Template ID.
          type: string
      required:
      - name
      - templateId
      type: object
      x-versionadded: v2.34
    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: The number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: List of custom jobs.
          items:
            $ref: '#/components/schemas/CustomJobResponse'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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:
      description: The custom job resources that will be applied in the k8s cluster.
      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.'
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        environmentId:
          description: The ID of the execution environment used for this custom job.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        environmentVersionId:
          description: The ID of the execution environment version used for this custom
            job.
          type:
          - string
          - 'null'
          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'
          maxItems: 1000
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        name:
          description: The name of the custom job.
          type: string
          x-versionadded: v2.33
        resources:
          $ref: '#/components/schemas/CustomJobResources'
          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'
          maxItems: 100
          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: The 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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        jobStatusId:
          description: ID to track the custom job run execution status.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        resources:
          $ref: '#/components/schemas/CustomJobResources'
          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'
          maxItems: 100
          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'
          x-versionadded: v2.33
      required:
      - metric
      type: object
    CustomMetricCategory:
      properties:
        baselineCount:
          description: A reference value for the current category count.
          type:
          - integer
          - 'null'
        directionality:
          description: Directionality of the custom metric category.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type: string
        value:
          description: Category value
          type: string
      required:
      - directionality
      - value
      type: object
      x-versionadded: v2.36
    CustomMetricCategorySummary:
      properties:
        baselineValue:
          description: A reference value for the current category count.
          type:
          - number
          - 'null'
        categoryName:
          description: Category value
          type: string
        percentChange:
          description: Percent change when compared with the reference value.
          type:
          - number
          - 'null'
        value:
          description: A value for the current category count.
          type:
          - number
          - 'null'
      required:
      - categoryName
      type: object
      x-versionadded: v2.36
    CustomMetricCondition:
      properties:
        categoryName:
          description: Category name for the custom metric. Only relevant for categorical
            metrics.
          maxLength: 256
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        compareOperator:
          description: Defines how the 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:
      description: Additional information related to custom metrics.
      properties:
        earliestDate:
          description: The earliest date of the custom metrics values.
          format: date-time
          type:
          - string
          - 'null'
        latestDate:
          description: The latest date of the custom metrics values.
          format: date-time
          type:
          - string
          - 'null'
      required:
      - earliestDate
      - latestDate
      type: object
    CustomMetricOverSpaceBucket:
      properties:
        categories:
          description: Aggregated custom metric categories in the bucket.
          items:
            $ref: '#/components/schemas/MetricCategory'
          maxItems: 25
          type: array
        hexagon:
          description: h3 hexagon.
          type: string
        sampleSize:
          description: Total number of values aggregated in the bucket.
          type:
          - integer
          - 'null'
        unknownCategoriesCount:
          description: The count of the values that do not correspond to the any of
            the known categories.
          type:
          - integer
          - 'null'
        value:
          description: Aggregated custom metric value in the bucket.
          type:
          - number
          - 'null'
      required:
      - hexagon
      type: object
      x-versionadded: v2.36
    CustomMetricSegment:
      properties:
        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
      - value
      type: object
      x-versionadded: v2.36
    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
      required:
      - column
      - name
      type: object
    CustomMetricSummary:
      properties:
        metric:
          $ref: '#/components/schemas/MetricSummary'
        period:
          $ref: '#/components/schemas/MetricPeriodBucket'
      required:
      - metric
      - period
      type: object
    CustomMetricsBulkBatchSummary:
      properties:
        metrics:
          default: []
          description: Custom metrics summaries.
          items:
            $ref: '#/components/schemas/MetricSummary'
          maxItems: 50
          type: array
          x-versionadded: v2.33
      required:
      - metrics
      type: object
    CustomMetricsBulkSummary:
      properties:
        details:
          $ref: '#/components/schemas/CustomMetricDetails'
          default: {}
        metrics:
          default: []
          description: Custom metrics summaries.
          items:
            $ref: '#/components/schemas/MetricSummary'
          maxItems: 50
          type: array
        period:
          $ref: '#/components/schemas/MetricPeriodBucket'
      required:
      - details
      - metrics
      - period
      type: object
    CustomMetricsHealth:
      description: Custom metrics health status setting.
      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'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          type:
          - string
          - 'null'
      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'
          maxItems: 1000
          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
    CustomModelChatLLMSettings:
      additionalProperties: false
      description: The settings that are available for custom model LLMs used via
        chat completion interface.
      properties:
        customModelId:
          description: The ID of the custom model used via chat completion interface.
          title: customModelId
          type: string
        customModelVersionId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model version used via chat completion
            interface.
          title: customModelVersionId
        systemPrompt:
          anyOf:
          - maxLength: 5000000
            type: string
          - type: 'null'
          description: System prompt guides the style of the LLM response. It is a
            "universal" prompt, prepended to all individual prompts.
          title: systemPrompt
      required:
      - customModelId
      title: CustomModelChatLLMSettings
      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: The 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
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          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
          type:
          - integer
          - 'null'
          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
          type:
          - string
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - DR_API_ACCESS
          - PUBLIC
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.30
        playgroundId:
          description: The ID of the GenAI Playground associated with the given custom
            inference model.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
        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: 0
          maximum: 25
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.30
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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
        tags:
          description: The list of a tag's name/value pairs.
          items:
            $ref: '#/components/schemas/CustomModelTagCreate'
          maxItems: 50
          minItems: 1
          type: array
          x-versionadded: v2.39
        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
          type:
          - string
          - 'null'
        targetType:
          description: The target type of the custom model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - GeoPoint
          - Unstructured
          - VectorDatabase
          - AgenticWorkflow
          - MCP
          - Multilabel
          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
    CustomModelCreateFromTemplatePayload:
      properties:
        nimContainerTagOverride:
          description: Allows to override the NIM container image tag.
          maxLength: 100
          type: string
          x-versionadded: v2.37
        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.'
          type: string
        secretConfigId:
          description: A secret configuration that is used by a custom model.
          type:
          - string
          - 'null'
        templateId:
          description: The id of the custom model template.
          type: string
      required:
      - resourceBundleId
      - templateId
      type: object
      x-versionadded: v2.36
    CustomModelCreateFromTemplateResponse:
      properties:
        customModelId:
          description: The id of the created custom model.
          type: string
        customModelVersionId:
          description: The id of the created custom model version.
          type: string
      required:
      - customModelId
      - customModelVersionId
      type: object
      x-versionadded: v2.36
    CustomModelDeploymentListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of custom model deployments.
          items:
            $ref: '#/components/schemas/CustomModelDeploymentResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        customModelImageId:
          description: The id of the custom model image associated with this deployment.
          type: string
        customModelVersion:
          $ref: '#/components/schemas/CustomModelVersionShortResponse'
        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'
        executionEnvironmentVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionShortResponse'
        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
    CustomModelDeploymentsLimitsLimitInfo:
      description: Limit info for the maximum number of custom model deployments.
      properties:
        limitReached:
          description: Whether the custom model deployment limit has been reached.
          type: boolean
        value:
          description: The maximum number of custom model deployments allowed (null
            if unlimited).
          type:
          - integer
          - 'null'
      required:
      - limitReached
      type: object
      x-versionadded: v2.42
    CustomModelDeploymentsLimitsResponse:
      properties:
        customModelDeploymentLimitUsageCount:
          description: Number of custom model deployments that count toward the limit
            (current limit usage).
          type: integer
        maxCustomDeploymentsLimit:
          $ref: '#/components/schemas/CustomModelDeploymentsLimitsLimitInfo'
      required:
      - customModelDeploymentLimitUsageCount
      - maxCustomDeploymentsLimit
      type: object
      x-versionadded: v2.42
    CustomModelDetails:
      description: Details of the custom model associated to this registered model
        version
      properties:
        createdAt:
          description: The time when the custom model was created.
          type: string
        creatorEmail:
          description: The email of the user who created the custom model.
          type:
          - string
          - 'null'
        creatorId:
          description: The ID of the creator of the custom model.
          type: string
        creatorName:
          description: The name of the user who created the custom model.
          type:
          - string
          - 'null'
        id:
          description: The ID of the associated custom model.
          type: string
        versionLabel:
          description: The label of the associated custom model version.
          type:
          - string
          - 'null'
          x-versionadded: v2.34
      required:
      - createdAt
      - creatorId
      - id
      type: object
    CustomModelEmbeddingValidationResponse:
      description: API response object for a single custom model embedding validation.
      properties:
        creationDate:
          description: The creation date of the custom model validation (ISO 8601
            formatted).
          format: date-time
          title: creationDate
          type: string
        deploymentAccessData:
          anyOf:
          - $ref: '#/components/schemas/DeploymentAccessData'
          - type: 'null'
          description: The parameters used for accessing the deployment.
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        deploymentName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the custom model deployment.
          title: deploymentName
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the validation error (if
            the validation failed).
          title: errorMessage
        id:
          description: The ID of the custom model validation.
          title: id
          type: string
        modelId:
          description: The ID of the model used in the deployment.
          title: modelId
          type: string
        name:
          description: The name of the validated custom model.
          title: name
          type: string
        predictionTimeout:
          description: The timeout in seconds for the prediction API used in this
            custom model validation.
          title: predictionTimeout
          type: integer
        promptColumnName:
          description: The name of the column the custom model uses for prompt text
            input.
          title: promptColumnName
          type: string
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          title: targetColumnName
          type: string
        tenantId:
          description: The ID of the tenant the custom model validation belongs to.
          format: uuid4
          title: tenantId
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case associated with the validated custom
            model.
          title: useCaseId
        userId:
          description: The ID of the user that created this custom model validation.
          title: userId
          type: string
        userName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the user that created this custom model validation.
          title: userName
        validationStatus:
          $ref: '#/components/schemas/CustomModelValidationStatus'
          description: The status of the custom model validation.
      required:
      - id
      - deploymentId
      - targetColumnName
      - validationStatus
      - modelId
      - deploymentAccessData
      - tenantId
      - name
      - useCaseId
      - creationDate
      - userId
      - predictionTimeout
      - promptColumnName
      title: CustomModelEmbeddingValidationResponse
      type: object
    CustomModelGuard:
      description: Details of a guard as defined for the custom model.
      properties:
        name:
          description: The name of the guard.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
        nemoEvaluatorType:
          anyOf:
          - $ref: '#/components/schemas/CustomModelGuardNemoEvaluatorType'
          - type: 'null'
          description: NeMo Evaluator type of the guard.
        ootbType:
          anyOf:
          - $ref: '#/components/schemas/CustomModelGuardOOTBType'
          - type: 'null'
          description: Out of the box type of the guard.
        stage:
          $ref: '#/components/schemas/CustomModelGuardStage'
          description: Stage on which the guard gets applied.
        type:
          $ref: '#/components/schemas/CustomModelGuardType'
          description: Type of the guard.
      required:
      - type
      - stage
      - name
      title: CustomModelGuard
      type: object
    CustomModelGuardNemoEvaluatorType:
      description: NeMo evaluator type as used in the moderation_config.yaml file
        of the custom model.
      enum:
      - llm_judge
      - context_relevance
      - response_groundedness
      - topic_adherence
      - agent_goal_accuracy
      - response_relevancy
      - faithfulness
      title: CustomModelGuardNemoEvaluatorType
      type: string
    CustomModelGuardOOTBType:
      description: OOTB type as used in the moderation_config.yaml file of the custom
        model.
      enum:
      - token_count
      - rouge_1
      - faithfulness
      - agent_goal_accuracy
      - custom_metric
      - cost
      - task_adherence
      title: CustomModelGuardOOTBType
      type: string
    CustomModelGuardStage:
      description: Guard stage as used in the moderation_config.yaml file of the custom
        model.
      enum:
      - prompt
      - response
      title: CustomModelGuardStage
      type: string
    CustomModelGuardType:
      description: Guard type as used in the moderation_config.yaml file of the custom
        model.
      enum:
      - ootb
      - model
      - nemo_guardrails
      - nemo_evaluator
      title: CustomModelGuardType
      type: string
    CustomModelImage:
      description: Contains information about the custom model image.
      properties:
        customModelId:
          description: ID of the custom model.
          type:
          - string
          - 'null'
        customModelName:
          description: Name of the custom model.
          type:
          - string
          - 'null'
        customModelVersionId:
          description: ID of the custom model version.
          type:
          - string
          - 'null'
        customModelVersionLabel:
          description: Label of the custom model version.
          type:
          - string
          - 'null'
        executionEnvironmentId:
          description: ID of the execution environment.
          type:
          - string
          - 'null'
        executionEnvironmentName:
          description: Name of the execution environment.
          type:
          - string
          - 'null'
        executionEnvironmentVersionId:
          description: ID of the execution environment version.
          type:
          - string
          - 'null'
        executionEnvironmentVersionLabel:
          description: Label of the execution environment version.
          type:
          - string
          - 'null'
      required:
      - customModelId
      - customModelName
      - customModelVersionId
      - customModelVersionLabel
      - executionEnvironmentId
      - executionEnvironmentName
      - executionEnvironmentVersionId
      - executionEnvironmentVersionLabel
      type: object
      x-versionadded: v2.36
    CustomModelLLMSettings:
      additionalProperties: false
      description: The settings that are available for custom model LLMs.
      properties:
        externalLlmContextSize:
          anyOf:
          - maximum: 128000.0
            minimum: 128.0
            type: integer
          - type: 'null'
          default: 4096
          description: The external LLM's context size, in tokens. This value is only
            used for pruning documents supplied to the LLM when a vector database
            is associated with the LLM blueprint. It does not affect the external
            LLM's actual context size in any way and is not supplied to the LLM.
          title: externalLlmContextSize
        systemPrompt:
          anyOf:
          - maxLength: 5000000
            type: string
          - type: 'null'
          description: System prompt guides the style of the LLM response. It is a
            "universal" prompt, prepended to all individual prompts.
          title: systemPrompt
        validationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The validation ID of the custom model LLM.
          title: validationId
      title: CustomModelLLMSettings
      type: object
    CustomModelLLMValidationResponse:
      description: API response object for a single custom model LLM validation.
      properties:
        chatModelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The model ID to specify when calling the OpenAI chat completion
            API of the deployment.
          title: chatModelId
        creationDate:
          description: The creation date of the custom model validation (ISO 8601
            formatted).
          format: date-time
          title: creationDate
          type: string
        deploymentAccessData:
          anyOf:
          - $ref: '#/components/schemas/DeploymentAccessData'
          - type: 'null'
          description: The parameters used for accessing the deployment.
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        deploymentName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the custom model deployment.
          title: deploymentName
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the validation error (if
            the validation failed).
          title: errorMessage
        id:
          description: The ID of the custom model validation.
          title: id
          type: string
        modelId:
          description: The ID of the model used in the deployment.
          title: modelId
          type: string
        name:
          description: The name of the validated custom model.
          title: name
          type: string
        predictionTimeout:
          description: The timeout in seconds for the prediction API used in this
            custom model validation.
          title: predictionTimeout
          type: integer
        promptColumnName:
          description: The name of the column the custom model uses for prompt text
            input.
          title: promptColumnName
          type: string
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          title: targetColumnName
          type: string
        tenantId:
          description: The ID of the tenant the custom model validation belongs to.
          format: uuid4
          title: tenantId
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case associated with the validated custom
            model.
          title: useCaseId
        userId:
          description: The ID of the user that created this custom model validation.
          title: userId
          type: string
        userName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the user that created this custom model validation.
          title: userName
        validationStatus:
          $ref: '#/components/schemas/CustomModelValidationStatus'
          description: The status of the custom model validation.
      required:
      - id
      - deploymentId
      - targetColumnName
      - validationStatus
      - modelId
      - deploymentAccessData
      - tenantId
      - name
      - useCaseId
      - creationDate
      - userId
      - predictionTimeout
      - promptColumnName
      title: CustomModelLLMValidationResponse
      type: object
    CustomModelListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of custom models.
          items:
            $ref: '#/components/schemas/CustomModelResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    CustomModelPredictionExplanations:
      properties:
        customModelId:
          description: The ID of the custom model.
          type: string
        customModelVersionId:
          description: The 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
          type:
          - integer
          - 'null'
        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
          type:
          - integer
          - 'null'
        maxCustomModelReplicasPerDeployment:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: 0
          maximum: 25
          type:
          - integer
          - 'null'
        maxCustomModelTestingParallelUsers:
          description: The maximum number of parallel users that can be used for Custom
            Model Testing checks
          exclusiveMinimum: 0
          maximum: 20
          type: integer
        minCustomModelContainerSize:
          description: The minimum memory that might be allocated by the custom-model.
          maximum: 134217728
          minimum: 134217728
          type:
          - integer
          - 'null'
          x-versionadded: v2.37
      required:
      - maxCustomModelTestingParallelUsers
      type: object
    CustomModelResourcesRequest:
      description: The structure that describes resource settings for a custom model
        created from buzok.
      properties:
        maximumMemory:
          anyOf:
          - type: integer
          - type: 'null'
          description: The maximum memory that can be allocated to the custom model.
          title: maximumMemory
        networkEgressPolicy:
          default: Public
          description: Network egress policy for the custom model. Can be either Public
            or None.
          maxLength: 5000
          title: networkEgressPolicy
          type: string
        replicas:
          default: 1
          description: A fixed number of replicas that will be created for the custom
            model.
          title: replicas
          type: integer
        resourceBundleId:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: 'An identifier that represents a bundle of resources: Memory,
            CPU, GPU, etc. A list of available bundles can be obtained via the resource
            bundles endpoint.'
          title: resourceBundleId
      title: CustomModelResourcesRequest
      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
          maxItems: 100
          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
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          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'
        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
          type:
          - integer
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.30
        playgroundId:
          description: The ID of the GenAI Playground associated with the given custom
            inference model.
          type:
          - string
          - 'null'
          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: 0
          maximum: 25
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.30
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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.'
          type:
          - string
          - 'null'
          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
        tags:
          description: A list of the custom model tag.
          items:
            $ref: '#/components/schemas/CustomModelTagRetrieveResponse'
          maxItems: 1000
          type: array
          x-versionadded: v2.39
        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
          - GeoPoint
          - Unstructured
          - VectorDatabase
          - AgenticWorkflow
          - MCP
          - Multilabel
          type: string
        template:
          $ref: '#/components/schemas/Template'
          x-versionadded: '2.36'
        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.
          type:
          - string
          - 'null'
        trainingDataPartitionColumn:
          description: The name of the column containing the partition assignments
            in training data if it was assigned previously and partitioning was provided.
          type:
          - string
          - 'null'
        trainingDatasetId:
          description: The ID of the dataset that was used as training data if it
            was assigned previously.
          type:
          - string
          - 'null'
        trainingDatasetVersionId:
          description: The ID of the dataset version that was used as training data
            if it was assigned previously.
          type:
          - string
          - 'null'
        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
      - template
      - updated
      type: object
    CustomModelShortResponse:
      description: Custom model associated with this deployment.
      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
    CustomModelTagCreate:
      properties:
        name:
          description: The name of the tag.
          maxLength: 50
          minLength: 1
          type: string
        value:
          description: The value of the tag.
          maxLength: 256
          minLength: 1
          type: string
      required:
      - name
      - value
      type: object
      x-versionadded: v2.39
    CustomModelTagRetrieveResponse:
      properties:
        id:
          description: The ID of the tag.
          type: string
        name:
          description: The name of the tag.
          type: string
        value:
          description: The value of the tag.
          type: string
      required:
      - id
      - name
      - value
      type: object
      x-versionadded: v2.39
    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.
      properties:
        errorCheck:
          $ref: '#/components/schemas/TestingStatus'
        longRunningService:
          $ref: '#/components/schemas/TestingStatus'
        nullValueImputation:
          $ref: '#/components/schemas/TestingStatus'
        sideEffects:
          $ref: '#/components/schemas/TestingStatus'
      type: object
    CustomModelTests:
      properties:
        configuration:
          $ref: '#/components/schemas/CustomModelTestsConfig'
        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
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          type:
          - string
          - 'null'
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: 0
          maximum: 25
          type:
          - integer
          - 'null'
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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.'
          type:
          - string
          - 'null'
          x-versionadded: v2.33
      required:
      - customModelId
      - customModelVersionId
      type: object
    CustomModelTestsConfig:
      description: Key value map of Testing type and Testing type config.
      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: The number of items returned on this page.
          type: integer
        data:
          description: List of custom model tests.
          items:
            $ref: '#/components/schemas/CustomModelTestsResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        customModelImageId:
          description: If testing was successful, ID of the custom inference model
            image that can be used for a deployment, otherwise null.
          type:
          - string
          - 'null'
        customModelVersion:
          $ref: '#/components/schemas/CustomModelVersionShortResponse'
        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
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.24
        executionEnvironment:
          $ref: '#/components/schemas/ExecutionEnvironmentShortResponse'
        executionEnvironmentVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionShortResponse'
        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
          type:
          - integer
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          type:
          - string
          - 'null'
        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: 0
          maximum: 25
          type:
          - integer
          - 'null'
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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.'
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        testingStatus:
          $ref: '#/components/schemas/CustomModelTesting'
      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
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          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
          type:
          - integer
          - 'null'
          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
          type:
          - string
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - DR_API_ACCESS
          - PUBLIC
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
        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: 0
          maximum: 25
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.30
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
      type: object
    CustomModelValidationStatus:
      description: Status of custom model validation.
      enum:
      - TESTING
      - PASSED
      - FAILED
      title: CustomModelValidationStatus
      type: string
    CustomModelVectorDatabaseValidationResponse:
      description: API response object for a single custom model vector database validation.
      properties:
        creationDate:
          description: The creation date of the custom model validation (ISO 8601
            formatted).
          format: date-time
          title: creationDate
          type: string
        deploymentAccessData:
          anyOf:
          - $ref: '#/components/schemas/DeploymentAccessData'
          - type: 'null'
          description: The parameters used for accessing the deployment.
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        deploymentName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the custom model deployment.
          title: deploymentName
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the validation error (if
            the validation failed).
          title: errorMessage
        id:
          description: The ID of the custom model validation.
          title: id
          type: string
        modelId:
          description: The ID of the model used in the deployment.
          title: modelId
          type: string
        name:
          description: The name of the validated custom model.
          title: name
          type: string
        predictionTimeout:
          description: The timeout in seconds for the prediction API used in this
            custom model validation.
          title: predictionTimeout
          type: integer
        promptColumnName:
          description: The name of the column the custom model uses for prompt text
            input.
          title: promptColumnName
          type: string
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          title: targetColumnName
          type: string
        tenantId:
          description: The ID of the tenant the custom model validation belongs to.
          format: uuid4
          title: tenantId
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case associated with the validated custom
            model.
          title: useCaseId
        userId:
          description: The ID of the user that created this custom model validation.
          title: userId
          type: string
        userName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the user that created this custom model validation.
          title: userName
        validationStatus:
          $ref: '#/components/schemas/CustomModelValidationStatus'
          description: The status of the custom model validation.
      required:
      - id
      - deploymentId
      - targetColumnName
      - validationStatus
      - modelId
      - deploymentAccessData
      - tenantId
      - name
      - useCaseId
      - creationDate
      - userId
      - predictionTimeout
      - promptColumnName
      title: CustomModelVectorDatabaseValidationResponse
      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
          type:
          - integer
          - 'null'
          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
            maxItems: 1000
            type: array
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          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)/`                 '
          type:
          - string
          - 'null'
          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:
          default: true
          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
          type:
          - integer
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          type:
          - string
          - 'null'
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: 0
          maximum: 25
          type:
          - integer
          - 'null'
        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. Field names and values are exposed as environment
            variables with values when running the custom model. Example: "required_metadata_values":
            [{"field_name": "hi", "value": "there"}],'
          type: string
          x-versionadded: v2.26
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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.'
          type:
          - string
          - 'null'
          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)/`                 '
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
            maxItems: 1000
            type: array
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          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)/`                 '
          type:
          - string
          - 'null'
          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:
          default: true
          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
          type:
          - integer
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          type:
          - string
          - 'null'
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: 0
          maximum: 25
          type:
          - integer
          - 'null'
        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. Field names and values are exposed as environment
            variables with values when running the custom model. Example: "required_metadata_values":
            [{"field_name": "hi", "value": "there"}],'
          type: string
          x-versionadded: v2.26
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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.'
          type:
          - string
          - 'null'
          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)/`                 '
          type:
          - string
          - 'null'
          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:
          default: true
          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'
          maxItems: 100
          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
            maxItems: 100
            type: array
      required:
      - repositoryId
      type: object
    CustomModelVersionFromCodespace:
      properties:
        codespaceId:
          description: The ID of the codespace that is the source for the custom model
            version files.
          type: string
      required:
      - codespaceId
      type: object
      x-versionadded: v2.37
    CustomModelVersionListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of custom model versions.
          items:
            $ref: '#/components/schemas/CustomModelVersionResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
          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'
          maxItems: 100
          type: array
          x-versionadded: v2.26
      type: object
    CustomModelVersionResponse:
      description: The latest version for the custom model (if this field is empty,
        the model is not ready for use).
      properties:
        baseEnvironmentId:
          description: The base environment to use with this model version.
          type:
          - string
          - 'null'
          x-versionadded: v2.22
        baseEnvironmentVersionId:
          description: The base environment version to use with this model version.
          type:
          - string
          - 'null'
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.22
        description:
          description: Description of a custom model version.
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
          x-versiondeprecated: v2.24
        gitModelVersion:
          $ref: '#/components/schemas/GitModelVersion'
          x-versionadded: v2.31
        holdoutData:
          $ref: '#/components/schemas/HoldoutDataResponse'
          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
          x-versiondeprecated: v2.34
        items:
          description: List of file items.
          items:
            $ref: '#/components/schemas/DeprecatedCustomModelWorkspaceItemResponse'
          maxItems: 100
          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
          type:
          - integer
          - 'null'
        networkEgressPolicy:
          description: Network egress policy.
          enum:
          - NONE
          - PUBLIC
          type:
          - string
          - 'null'
        replicas:
          description: A fixed number of replicas that will be set for the given custom-model.
          exclusiveMinimum: 0
          maximum: 25
          type:
          - integer
          - 'null'
        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'
          maxItems: 100
          type: array
          x-versionadded: v2.26
        requiresHa:
          description: Require all custom model replicas to be deployed on different
            Kubernetes nodes for predictions fault tolerance.
          type:
          - boolean
          - 'null'
          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.'
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        trainingData:
          $ref: '#/components/schemas/TrainingDataResponse'
          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:
      description: Custom model version associated with this deployment.
      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
    CustomModelVersionToCodespace:
      properties:
        codespaceId:
          description: The ID of the codespace that should be updated with custom
            model version files.
          type: string
      required:
      - codespaceId
      type: object
      x-versionadded: v2.37
    CustomRetrainingJob:
      description: The ID, schedule, and last run for the custom job.
      properties:
        id:
          description: The ID of the custom job associated with the policy.
          maxLength: 24
          type: string
        lastRun:
          description: The ISO-8601 timestamp of when the custom job was last run.
          maxLength: 256
          type:
          - string
          - 'null'
        status:
          description: Status of the custom job run.
          type:
          - string
          - 'null'
      required:
      - lastRun
      - status
      type: object
      x-versionadded: v2.37
    CustomScoringMetricsInfo:
      description: Returns custom scoring metrics information. This field is required
        for custom scoring metrics projects.
      properties:
        id:
          description: The ID of an existing custom scoring metric in the registry
            collection.
          type: string
          x-versionadded: v2.46
        registryVersionId:
          description: The ID of a custom scoring metric registry version. When omitted,
            the latest version is used.
          type:
          - string
          - 'null'
          x-versionadded: v2.46
      required:
      - id
      type: object
      x-versionadded: v2.45
    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'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          type:
          - string
          - 'null'
      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: The 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
          type:
          - integer
          - 'null'
          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
          - GeoPoint
          type: string
      required:
      - name
      - targetType
      type: object
    CustomTaskListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of custom tasks.
          items:
            $ref: '#/components/schemas/CustomTaskResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        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
          type:
          - integer
          - 'null'
          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
          - GeoPoint
          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
          type:
          - integer
          - 'null'
          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
            maxItems: 1000
            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
          type:
          - integer
          - 'null'
          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
            maxItems: 1000
            type: array
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            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
          type:
          - integer
          - 'null'
          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'
          maxItems: 100
          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
            maxItems: 100
            type: array
      required:
      - baseEnvironmentId
      - repositoryId
      type: object
    CustomTaskVersionDependencyBuildMetadataResponse:
      properties:
        buildEnd:
          description: The ISO-8601 encoded time when this build completed.
          type:
          - string
          - 'null'
        buildLogLocation:
          description: The URL to download the build logs from this build.
          format: uri
          type:
          - string
          - 'null'
        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
          - aborted
          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: The number of items returned on this page.
          type: integer
        data:
          description: List of custom task versions.
          items:
            $ref: '#/components/schemas/CustomTaskVersionResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
          maxItems: 100
          type: array
          x-versionadded: v2.26
      type: object
    CustomTaskVersionResponse:
      description: The latest version for the custom task (if this field is empty
        the task is not ready for use).
      properties:
        baseEnvironmentId:
          description: The base environment to use with this task version.
          type:
          - string
          - 'null'
        baseEnvironmentVersionId:
          description: The base environment version to use with this task version.
          type:
          - string
          - 'null'
        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'
          maxItems: 1000
          type: array
        description:
          description: Description of a custom task version.
          type:
          - string
          - 'null'
        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
          x-versiondeprecated: v2.34
        items:
          description: List of file items.
          items:
            $ref: '#/components/schemas/WorkspaceItemResponse'
          maxItems: 100
          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
          type:
          - integer
          - 'null'
          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'
          maxItems: 100
          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
          maxItems: 100
          type: array
      required:
      - created
      - customModelId
      - customTaskId
      - description
      - id
      - isFrozen
      - items
      - label
      - outboundNetworkPolicy
      - versionMajor
      - versionMinor
      type: object
    CustomTemplateCreatePayload:
      properties:
        defaultEnvironment:
          description: Specifies the default environment for the custom metric template.
          type: string
        defaultResourceBundleId:
          description: Specifies the default resource bundle for the custom metric
            template.
          enum:
          - cpu.nano
          - cpu.micro
          - cpu.small
          - cpu.medium
          - cpu.large
          - cpu.xlarge
          - cpu.2xlarge
          - cpu.3xlarge
          - cpu.4xlarge
          - cpu.5xlarge
          - cpu.6xlarge
          - cpu.7xlarge
          - cpu.8xlarge
          - cpu.16xlarge
          - DRAWSR6i.4xlargeFrac8Regular
          - DRAWSR6i.4xlargeFrac4Regular
          - DRAWSG4dn.xlargeFrac1Regular
          - DRAWSG4dn.2xlargeFrac1Regular
          - DRAWSG5.2xlargeFrac1Regular
          - DRAWSG5.12xlargeFrac1Regular
          - DRAWSG5.48xlargeFrac1Regular
          - DRAWSG6e.xlargeFrac1Regular
          - DRAWSG6e.12xlargeFrac1Regular
          - DRAWSG6e.48xlargeFrac1Regular
          - gpu.small
          - gpu.medium
          - gpu.large
          - gpu.xlarge
          - gpu.2xlarge
          - gpu.3xlarge
          - gpu.5xlarge
          - gpu.7xlarge
          - starter
          - basic
          - basic.8x
          - train.l
          - infer.s
          - infer.m
          - infer.l
          type: string
        description:
          description: A description of the custom template.
          maxLength: 10000
          type: string
        enabled:
          default: true
          description: Disabled templates remain visible in the UI but cannot be used.
          type: boolean
          x-versionadded: v2.36
        file:
          description: The file to be used to create the custom metric template.
          format: binary
          type: string
        isHidden:
          default: false
          description: Hidden templates are not visible in the UI.
          type: boolean
          x-versionadded: v2.37
        name:
          description: The name of the custom template.
          maxLength: 255
          type: string
        templateMetadata:
          description: Specifies permanent metadata for the custom template.
          type:
          - string
          - 'null'
        templateSubType:
          description: Defines sub-type of the custom template.
          maxLength: 255
          type: string
        templateType:
          description: Defines type of the custom template.
          maxLength: 255
          type: string
      required:
      - defaultEnvironment
      - description
      - file
      - name
      - templateSubType
      - templateType
      type: object
      x-versionadded: v2.36
    CustomTemplateEntity:
      properties:
        defaultEnvironment:
          $ref: '#/components/schemas/DefaultEnvironment'
        defaultResourceBundleId:
          description: Specifies the default resource bundle for the custom metric
            template.
          enum:
          - cpu.nano
          - cpu.micro
          - cpu.small
          - cpu.medium
          - cpu.large
          - cpu.xlarge
          - cpu.2xlarge
          - cpu.3xlarge
          - cpu.4xlarge
          - cpu.5xlarge
          - cpu.6xlarge
          - cpu.7xlarge
          - cpu.8xlarge
          - cpu.16xlarge
          - DRAWSR6i.4xlargeFrac8Regular
          - DRAWSR6i.4xlargeFrac4Regular
          - DRAWSG4dn.xlargeFrac1Regular
          - DRAWSG4dn.2xlargeFrac1Regular
          - DRAWSG5.2xlargeFrac1Regular
          - DRAWSG5.12xlargeFrac1Regular
          - DRAWSG5.48xlargeFrac1Regular
          - DRAWSG6e.xlargeFrac1Regular
          - DRAWSG6e.12xlargeFrac1Regular
          - DRAWSG6e.48xlargeFrac1Regular
          - gpu.small
          - gpu.medium
          - gpu.large
          - gpu.xlarge
          - gpu.2xlarge
          - gpu.3xlarge
          - gpu.5xlarge
          - gpu.7xlarge
          - starter
          - basic
          - basic.8x
          - train.l
          - infer.s
          - infer.m
          - infer.l
          type:
          - string
          - 'null'
        description:
          description: A description of the custom template.
          maxLength: 10000
          type: string
        enabled:
          description: Determines whether the template is enabled.
          type: boolean
        id:
          description: The ID of the custom template.
          type: string
        items:
          description: A list of custom files.
          items:
            $ref: '#/components/schemas/CustomTemplateFile'
          maxItems: 1000
          type: array
        name:
          description: The name of the custom template.
          maxLength: 255
          type: string
        templateMetadata:
          $ref: '#/components/schemas/TemplateMetadata'
        templateSubType:
          description: Defines the type of the custom template.
          maxLength: 255
          type:
          - string
          - 'null'
        templateType:
          description: Defines the type of the custom template.
          maxLength: 255
          type: string
      required:
      - defaultEnvironment
      - defaultResourceBundleId
      - description
      - enabled
      - id
      - items
      - name
      - templateMetadata
      - templateSubType
      - templateType
      type: object
      x-versionadded: v2.36
    CustomTemplateFile:
      properties:
        id:
          description: The ID of the custom template file.
          type: string
        name:
          description: Name of the custom template file.
          maxLength: 255
          type: string
      required:
      - id
      - name
      type: object
      x-versionadded: v2.36
    CustomTemplateFileResponse:
      properties:
        content:
          description: The content of the chosen file.
          type: string
        contentEncoding:
          description: The encoding of the content field. Either "utf-8" for text
            files or "base64" for binary files such as images.
          type: string
          x-versionadded: v2.43
        fileName:
          description: The name of the chosen file.
          type: string
        id:
          description: The ID of the file.
          type: string
      required:
      - content
      - contentEncoding
      - fileName
      - id
      type: object
      x-versionadded: v2.38
    CustomTemplateListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A list of custom templates.
          items:
            $ref: '#/components/schemas/CustomTemplateEntity'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    CustomTemplateUpdatePayload:
      properties:
        defaultEnvironment:
          description: Specifies the default environment for the custom template.
          type: string
        defaultResourceBundleId:
          description: Specifies the default resource bundle for the custom metric
            template.
          enum:
          - cpu.nano
          - cpu.micro
          - cpu.small
          - cpu.medium
          - cpu.large
          - cpu.xlarge
          - cpu.2xlarge
          - cpu.3xlarge
          - cpu.4xlarge
          - cpu.5xlarge
          - cpu.6xlarge
          - cpu.7xlarge
          - cpu.8xlarge
          - cpu.16xlarge
          - DRAWSR6i.4xlargeFrac8Regular
          - DRAWSR6i.4xlargeFrac4Regular
          - DRAWSG4dn.xlargeFrac1Regular
          - DRAWSG4dn.2xlargeFrac1Regular
          - DRAWSG5.2xlargeFrac1Regular
          - DRAWSG5.12xlargeFrac1Regular
          - DRAWSG5.48xlargeFrac1Regular
          - DRAWSG6e.xlargeFrac1Regular
          - DRAWSG6e.12xlargeFrac1Regular
          - DRAWSG6e.48xlargeFrac1Regular
          - gpu.small
          - gpu.medium
          - gpu.large
          - gpu.xlarge
          - gpu.2xlarge
          - gpu.3xlarge
          - gpu.5xlarge
          - gpu.7xlarge
          - starter
          - basic
          - basic.8x
          - train.l
          - infer.s
          - infer.m
          - infer.l
          type: string
        description:
          description: A description of the custom template.
          maxLength: 10000
          type: string
        enabled:
          default: true
          description: Disabled templates remain visible in the UI but cannot be used.
          type: boolean
          x-versionadded: v2.36
        file:
          description: The file to be used to create the custom template.
          format: binary
          type: string
        isHidden:
          default: false
          description: Hidden templates are not visible in the UI.
          type: boolean
          x-versionadded: v2.37
        name:
          description: The name of the custom template.
          maxLength: 255
          type: string
        templateMetadata:
          description: Specifies permanent metadata for the custom template.
          type:
          - string
          - 'null'
        templateSubType:
          description: Defines the sub-type of the custom template.
          maxLength: 255
          type: string
        templateType:
          description: Defines the type of the custom template.
          maxLength: 255
          type: string
      type: object
      x-versionadded: v2.36
    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: The number of items returned on this page.
          type: integer
        data:
          description: List of training model blueprints.
          items:
            $ref: '#/components/schemas/CustomTrainingBlueprintResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        customModelVersion:
          $ref: '#/components/schemas/CustomModelVersionShortResponse'
        executionEnvironment:
          $ref: '#/components/schemas/ExecutionEnvironmentShortResponse'
        executionEnvironmentVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionShortResponse'
        targetType:
          description: The target type of the training model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - GeoPoint
          - Unstructured
          - VectorDatabase
          - AgenticWorkflow
          - MCP
          - Multilabel
          type: string
        trainingHistory:
          description: List of instances of this blueprint having been trained.
          items:
            $ref: '#/components/schemas/TrainingHistoryEntry'
          maxItems: 1000
          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: The ID of the connector.
          type: string
        fields:
          description: The connector fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - connectorId
      - fields
      type: object
    DRConnectorV1DataSource:
      properties:
        dataStoreId:
          description: The data store ID for this data source.
          type: string
          x-versionadded: v2.22
        filter:
          description: An optional filter string for narrowing results, which overrides
            `path` when specified. Only supported by the Jira connector.
          maxLength: 320000
          type: string
          x-versionadded: v2.39
        path:
          description: The 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: The ID of the connector.
          type: string
        fieldSchemas:
          description: The connector field schemas.
          items:
            $ref: '#/components/schemas/ConnectorFieldSchema'
          type: array
        fields:
          description: The connector fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - connectorId
      - fields
      type: object
    DRConnectorV1Field:
      properties:
        id:
          description: The field name.
          type: string
        name:
          description: The user-friendly displayable field name.
          type: string
        value:
          description: The field value.
          type: string
      required:
      - name
      - value
      type: object
    DRConnectorV1Update:
      properties:
        fields:
          description: The connector fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      type: object
    DREntity:
      properties:
        id:
          description: The ID of the 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
    DRFileMetadata:
      description: Metadata for DataRobot files.
      properties:
        commandArgs:
          description: Command arguments for the file.
          title: Commandargs
          type: string
      title: DRFileMetadata
      type: object
    DRFilesystemMetadataResponse:
      description: Response schema for DataRobot filesystem metadata.
      properties:
        datarobotMetadata:
          additionalProperties:
            $ref: '#/components/schemas/DRFileMetadata'
          description: Metadata for the files.
          title: Datarobotmetadata
          type: object
      required:
      - datarobotMetadata
      title: DRFilesystemMetadataResponse
      type: object
    DSS:
      description: Stream CSV data chunks from DSS dataset
      properties:
        datasetId:
          description: The ID of the dataset
          type: string
        partition:
          default: null
          description: Partition used to predict
          enum:
          - holdout
          - validation
          - allBacktests
          - null
          type:
          - string
          - 'null'
        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:
      description: Stream CSV data chunks from DSS dataset
      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
          - null
          type:
          - string
          - 'null'
        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:
      description: Computed data disparity insights if available.
      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'
          type: array
      type: object
    DataDisparityRetrieveResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          $ref: '#/components/schemas/DataDisparityInsights'
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DataDriftHealth:
      description: Data drift health status setting.
      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: integer
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        highImportanceWarningCount:
          description: Threshold of drifted high importance feature count for warning
            status.
          minimum: 1
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        lowImportanceWarningCount:
          description: Threshold of drifted low importance feature count for warning
            status.
          minimum: 1
          type:
          - integer
          - 'null'
          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
          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
    DataFrameEntrySchema:
      description: Schema for a single DataFrame entry.
      properties:
        name:
          description: Name of the DataFrame.
          title: Name
          type: string
        type:
          description: Type of the DataFrame.
          title: Type
          type: string
      required:
      - name
      - type
      title: DataFrameEntrySchema
      type: object
    DataFrameResponseSchema:
      description: Schema for the DataFrame response.
      properties:
        dataframe:
          description: The DataFrame as a string.
          title: Dataframe
          type: string
      required:
      - dataframe
      title: DataFrameResponseSchema
      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'
          type: array
        timestamp:
          description: ISO-formatted timestamp for the row.
          format: date-time
          type: string
      required:
      - prediction
      - shapExplanation
      - timestamp
      type: object
    DataQualityItem:
      properties:
        actualValue:
          description: Actual value
          type:
          - string
          - 'null'
        associationId:
          description: Association ID of prediction.
          type: string
        context:
          description: A list of contexts used for text generation response.
          items:
            $ref: '#/components/schemas/ContextItem'
          maxItems: 10
          type: array
        metrics:
          description: A list of collected metrics associated with the prediction
            instance.
          items:
            $ref: '#/components/schemas/MetricValue'
          maxItems: 100
          type: array
        predictedValue:
          description: Predicted value(s)
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
          - type: 'null'
        prompt:
          description: Prompt for text generation target types.
          type:
          - string
          - 'null'
        timestamp:
          description: Record creation timestamp.
          format: date-time
          type: string
      required:
      - actualValue
      - associationId
      - context
      - metrics
      - predictedValue
      - prompt
      - timestamp
      type: object
      x-versionadded: v2.35
    DataQualityResponse:
      properties:
        count:
          description: Number of paginated entries.
          minimum: 0
          type: integer
        data:
          description: A list of prediction data exports.
          items:
            $ref: '#/components/schemas/DataQualityItem'
          maxItems: 100
          type: array
        next:
          description: The URL to the next page, or null if there is no such page.
          type:
          - string
          - 'null'
        previous:
          description: The URL to the previous page, or null if there is no such page.
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of entries.
          minimum: 0
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    DataQualityWarningsRecord:
      description: A Json object of available warnings about potential problems in
        this prediction dataset. Empty if no warnings.
      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
    DataRobotCodeRef:
      additionalProperties: false
      properties:
        catalogId:
          title: Catalogid
          type: string
        catalogVersionId:
          title: Catalogversionid
          type: string
      required:
      - catalogId
      - catalogVersionId
      title: DataRobotCodeRef
      type: object
    DataRobotUser:
      description: DataRobot application user.
      properties:
        id:
          description: The ID of the user.
          title: id
          type: string
        name:
          description: The name of the user.
          title: name
          type: string
        userhash:
          anyOf:
          - type: string
          - type: 'null'
          description: Gravatar hash for user avatar.
          title: userhash
      required:
      - id
      - name
      title: DataRobotUser
      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'.
          type:
          - string
          - 'null'
        modelId:
          description: The model ID whose training dataset should be sliced. Use this
            parameter only when the source is 'training'.
          type:
          - string
          - 'null'
        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
          - vectorDatabase
          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'.
          type:
          - string
          - 'null'
        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'.
          type:
          - string
          - 'null'
        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
          - vectorDatabase
          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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DataSource:
      description: Data source details for a JDBC dataset
      properties:
        catalog:
          description: Catalog name of the data source.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        url:
          description: URL of the data store.
          type: string
      required:
      - dataStoreId
      - dataStoreName
      - dbtable
      - schema
      - url
      type: object
    DataSourceCreate:
      properties:
        canonicalName:
          description: The data source canonical name.
          type: string
        params:
          description: The data source configuration.
          oneOf:
          - $ref: '#/components/schemas/DatabaseTableDataSource'
          - $ref: '#/components/schemas/DatabaseQueryDataSource'
          - $ref: '#/components/schemas/DRConnectorV1DataSource'
        type:
          description: The 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: The data source canonical name.
          type: string
        creator:
          description: The 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: The data source ID.
          type: string
        params:
          description: The data source configuration.
          oneOf:
          - $ref: '#/components/schemas/DatabaseTableDataSource'
          - $ref: '#/components/schemas/DatabaseQueryDataSource'
          - $ref: '#/components/schemas/DRConnectorV1DataSource'
        role:
          description: The role of the user making the request on this data source.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        type:
          description: The data source type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        updated:
          description: The 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: The list of data sources.
          items:
            $ref: '#/components/schemas/DataSourceInList'
          type: array
      required:
      - data
      type: object
    DataSourceRetrieveResponse:
      properties:
        canonicalName:
          description: The data source canonical name.
          type: string
        creator:
          description: The 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: The data source ID.
          type: string
        params:
          description: The data source configuration.
          oneOf:
          - $ref: '#/components/schemas/DatabaseTableDataSource'
          - $ref: '#/components/schemas/DatabaseQueryDataSource'
          - $ref: '#/components/schemas/DRConnectorV1DataSource'
        role:
          description: The role of the user making the request on this data source.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        type:
          description: The data source type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        updated:
          description: The 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: The data source's 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:
      description: Stream CSV data chunks from data stage storage
      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
    DataStageFinalizeResponse:
      properties:
        parts:
          description: The size of the part.
          items:
            $ref: '#/components/schemas/PartFinalizeResponse'
          maxItems: 1000
          minItems: 1
          type: array
      required:
      - parts
      type: object
      x-versionadded: v2.35
    DataStageIntake:
      description: Stream CSV data chunks from data stage storage
      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: The data type of the column.
          type: string
        name:
          description: The name of the column.
          type: string
        precision:
          description: The precision of the column.
          type:
          - string
          - 'null'
        scale:
          description: The scale of the column.
          type:
          - string
          - 'null'
      required:
      - dataType
      - name
      - precision
      - scale
      type: object
    DataStoreColumnsInfoList:
      properties:
        catalog:
          description: The name of the specified database catalog.
          type:
          - string
          - 'null'
        credentialId:
          description: The ID of the set of credentials to use instead of username
            and password.
          type: string
          x-versionadded: v2.19
        password:
          description: The password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        schema:
          description: The schema name.
          type: string
        table:
          description: The table name.
          type: string
        useKerberos:
          default: false
          description: Whether to use Kerberos for data store authentication.
          type: boolean
          x-versionadded: v2.19
        user:
          description: The username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      required:
      - table
      type: object
    DataStoreColumnsInfoListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of data store columns metadata.
          items:
            $ref: '#/components/schemas/DataStoreExtendedColumnResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DataStoreColumnsList:
      properties:
        catalog:
          description: The name of the specified database catalog.
          type:
          - string
          - 'null'
        credentialId:
          description: The ID of the credential mapping.
          type: string
        password:
          description: The password for the db connection.
          type: string
        query:
          description: The schema query.
          type: string
        schema:
          description: The schema name.
          type: string
        table:
          description: The table name.
          type: string
        user:
          description: The username for the db connection.
          type: string
      type: object
    DataStoreColumnsListResponse:
      properties:
        columns:
          description: The 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: The data store configuration.
          oneOf:
          - $ref: '#/components/schemas/JDBCDataStoreCreate'
          - $ref: '#/components/schemas/DRConnectorV1Create'
          - $ref: '#/components/schemas/DatabaseDataStoreCreate'
        type:
          description: The data store type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
      required:
      - canonicalName
      - params
      - type
      type: object
    DataStoreCredentials:
      properties:
        credentialId:
          description: The ID of the set of credentials to use instead of username
            and password.
          type: string
          x-versionadded: v2.19
        password:
          description: The 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: The username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      type: object
    DataStoreCredentialsWithCredentialsTypeSupport:
      properties:
        credentialData:
          description: The type of credentials to use with the data store.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentialsFields'
          - $ref: '#/components/schemas/GcpCredentialsFields'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentialsFields'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentialsFields'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentialsFields'
          - $ref: '#/components/schemas/AzureConnectionStringCredentialsFields'
          - $ref: '#/components/schemas/AzureSasCredentialsFields'
          - $ref: '#/components/schemas/ExternalOAuthProviderCredentialsFields'
          - $ref: '#/components/schemas/BOXJWTCredentialsFields'
          - $ref: '#/components/schemas/ClientIdAndSecretCredentialsFields'
          x-versionadded: v2.23
        credentialId:
          description: The ID of the set of credentials to use instead of username
            and password.
          type: string
          x-versionadded: v2.19
        password:
          description: The 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: The 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:
      description: JDBC result column description
      properties:
        columnDefaultValue:
          description: Default value of the column.
          type:
          - string
          - 'null'
          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'
          type:
          - string
          - 'null'
          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: The default value of the column.
          type:
          - string
          - 'null'
        comment:
          description: The comment of the column.
          type:
          - string
          - 'null'
        dataType:
          description: The data type of the column.
          type: string
        dataTypeInt:
          description: The 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
          - 'null'
        isNullable:
          description: Whether the column values can be null.
          enum:
          - 'NO'
          - UNKNOWN
          - 'YES'
          type:
          - string
          - 'null'
        name:
          description: The name of the column.
          type: string
        precision:
          description: The precision of the column.
          type:
          - integer
          - 'null'
        primaryKeys:
          description: The primary key columns of the table.
          items:
            type: string
          type: array
        scale:
          description: The scale of the column.
          type:
          - integer
          - 'null'
      required:
      - columnDefaultValue
      - comment
      - dataType
      - dataTypeInt
      - exportedKeys
      - importedKeys
      - isInPrimaryKey
      - isNullable
      - name
      - precision
      - primaryKeys
      - scale
      type: object
    DataStoreListResponse:
      properties:
        data:
          description: The list of data stores.
          items:
            $ref: '#/components/schemas/DataStoreRetrieveResponse'
          type: array
      required:
      - data
      type: object
    DataStorePreviewResponse:
      properties:
        columns:
          description: The list of columns for the returned set of records. Column
            order matches the order of values in a record.
          items:
            description: The name of the column.
            type: string
          maxItems: 20000
          type: array
        records:
          description: The list of records output by the query.
          items:
            description: The list of values for a single database record, ordered
              as the columns are ordered.
            items:
              description: The string representation of the column's value.
              type: string
            type: array
          maxItems: 10000
          type: array
        resultSchema:
          description: The JDBC result schema.
          items:
            $ref: '#/components/schemas/DataStoreResultSchemaResponse'
          maxItems: 20000
          type: array
      required:
      - columns
      - records
      - resultSchema
      type: object
      x-versionadded: v2.43
    DataStoreResultSchemaResponse:
      description: The JDBC result column description.
      properties:
        dataType:
          description: The data type of the column.
          type: string
        dataTypeInt:
          description: The integer value of the column data type.
          type:
          - integer
          - 'null'
        name:
          description: The name of the column.
          type: string
        precision:
          description: The precision of the column.
          type:
          - integer
          - 'null'
        scale:
          description: The scale of the column.
          type:
          - integer
          - 'null'
      required:
      - dataType
      - dataTypeInt
      - name
      - precision
      - scale
      type: object
      x-versionadded: v2.43
    DataStoreRetrieveResponse:
      properties:
        associatedAuthTypes:
          description: The supported authentication types for the JDBC configuration.
          items:
            enum:
            - adls_gen2_oauth
            - azure_sas
            - azure_service_principal
            - basic
            - box_jwt
            - 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: The ID of the user who created the data store.
          type: string
        id:
          description: The data store ID.
          type: string
        params:
          description: The data store configuration.
          oneOf:
          - $ref: '#/components/schemas/JDBCDataStoreDetails'
          - $ref: '#/components/schemas/DRConnectorV1Details'
          - $ref: '#/components/schemas/DatabaseDataStoreDetails'
        role:
          description: The role of the user making the request on this data store.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          type: string
        type:
          description: The data store type.
          enum:
          - dr-connector-v1
          - dr-database-v1
          - jdbc
          type: string
        updated:
          description: The 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: The ID of the set of credentials to use instead of username
            and password.
          type: string
          x-versionadded: v2.19
        maxRows:
          description: The maximum number of rows of data to return if successful.
          maximum: 999
          minimum: 0
          type: integer
        password:
          description: The password for data store authentication.
          type: string
          x-versiondeprecated: v2.23
        query:
          description: The 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: The username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      required:
      - maxRows
      - query
      type: object
    DataStoreSQLVerifyResponse:
      properties:
        columns:
          description: The list of columns for the returned set of records. Column
            order matches the order of values in a record.
          items:
            description: The name of the column.
            type: string
          maxItems: 20000
          type: array
        records:
          description: The list of records output by the query.
          items:
            description: The list of values for a single database record, ordered
              as the columns are ordered.
            items:
              description: The string representation of the column's value.
              type: string
            type: array
          maxItems: 10000
          type: array
      required:
      - columns
      - records
      type: object
    DataStoreSchemasList:
      properties:
        catalog:
          description: The 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: The list of catalogs associated with each retrieved schema.
            If no catalog is found, this value is null.
          items:
            description: The catalog names for the schema associated with the data
              store.
            type:
            - string
            - 'null'
          type: array
        schemas:
          description: The 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: The ID of the set of credentials to use instead of username
            and password.
          type: string
          x-versionadded: v2.19
        password:
          description: The 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: The username for data store authentication.
          type: string
          x-versiondeprecated: v2.23
      type: object
    DataStoreTablesList:
      properties:
        catalog:
          description: The catalog associated with schemas.
          type:
          - string
          - 'null'
        tables:
          description: The list of tables in the data store.
          items:
            $ref: '#/components/schemas/TableDescription'
          type: array
      required:
      - catalog
      - tables
      type: object
    DataStoreTestResponse:
      properties:
        message:
          description: The 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: The data store configuration.
          oneOf:
          - $ref: '#/components/schemas/JDBCDataStoreUpdate'
          - $ref: '#/components/schemas/DRConnectorV1Update'
      type: object
    DatabaseDataStoreCreate:
      properties:
        driverId:
          description: The database driver ID.
          type: string
        fields:
          description: The database driver fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - driverId
      - fields
      type: object
    DatabaseDataStoreDetails:
      properties:
        driverId:
          description: The database driver ID.
          type: string
        fieldSchemas:
          description: The database driver field schemas.
          items:
            $ref: '#/components/schemas/ConnectorFieldSchema'
          type: array
        fields:
          description: The database driver fields.
          items:
            $ref: '#/components/schemas/DRConnectorV1Field'
          type: array
      required:
      - driverId
      - fields
      type: object
    DatabaseQueryDataSource:
      properties:
        dataStoreId:
          description: The data store ID for this data source.
          type: string
        fetchSize:
          description: The 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: 320000
          type: string
      required:
      - dataStoreId
      - query
      type: object
    DatabaseTableDataSource:
      properties:
        catalog:
          description: The catalog name in the database if supported.
          maxLength: 256
          type: string
        dataStoreId:
          description: The data store ID for this data source.
          type: string
        fetchSize:
          description: The 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: The schema associated with the table or view in the database
            if the data source is not query based.
          maxLength: 256
          type: string
        table:
          description: The table or view name in the database if the data source is
            not query based.
          maxLength: 256
          type: string
      required:
      - dataStoreId
      - table
      type: object
    DatabricksAccessTokenCredentialsFields:
      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
          x-versionadded: v2.31
      required:
      - credentialType
      - databricksAccessToken
      type: object
      x-versionadded: v2.46
    DatabricksDataStreamer:
      description: Stream CSV data chunks from Databricks using browser-databricks
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the data source.
            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 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:
          - databricks
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.43
    DatabricksIntake:
      description: Stream CSV data chunks from Databricks using browser-databricks
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the data source.
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          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:
          - databricks
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.43
    DatabricksOutput:
      description: Saves CSV data chunks to Databricks using browser-databricks
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            write access to the data destination.
          type: string
        dataStoreId:
          description: The ID of the data store to connect to
          type: string
        schema:
          description: The name of the specified database schema to write output data
            to.
          type: string
        table:
          description: The name of the specified database table to write output data
            to.
          type: string
        type:
          description: The type name for this output type
          enum:
          - databricks
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.43
    DatabricksOutputAdaptor:
      description: Saves CSV data chunks to Databricks using browser-databricks
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the data destination.
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The 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 output data
            to.
          type: string
        table:
          description: The name of the specified database table to write output data
            to.
          type: string
        type:
          description: The type name for this output type
          enum:
          - databricks
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.43
    DatabricksServicePrincipalCredentialsFields:
      properties:
        clientId:
          description: Client ID for Databricks service principal.
          minLength: 1
          type: string
          x-versionadded: v2.33
        clientSecret:
          description: Client secret for Databricks service principal.
          minLength: 1
          type: string
          x-versionadded: v2.33
        configId:
          description: The ID of the saved shared credentials. If specified, cannot
            include clientId and clientSecret.
          type: string
          x-versionadded: v2.33
        credentialType:
          description: The type of these credentials, 'databricks_service_principal_account'
            here.
          enum:
          - databricks_service_principal_account
          type: string
      required:
      - credentialType
      type: object
      x-versionadded: v2.46
    Dataset:
      description: The dataset that will be used as retraining data.
      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: The number of items returned on this page.
          type: integer
        data:
          description: The list of DatasetAccessControl objects.
          items:
            $ref: '#/components/schemas/DatasetAccessControlResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
            (e.g., use it to create projects, predictions, etc) data. 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 entity,
            grant the user read access to any linked objects such as `DataSources`
            and `DataStores` that may be used by this entity. Ignored if no such objects
            are relevant for the entity. This 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 the user making the call
            does not have sufficient permissions to complete the 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: The JDBC credentials.
          type: string
        datasetName:
          description: The 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: The ID of the workspace state to use as the source of data.
          type: string
      required:
      - workspaceStateId
      type: object
    DatasetCreateVersionFromRecipe:
      properties:
        credentialData:
          description: The credentials to authenticate with the database, to be used
            instead of credential ID.
          oneOf:
          - $ref: '#/components/schemas/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          x-versionadded: v2.37
        credentialId:
          description: The ID of the set of credentials to authenticate with the database.
          type: string
          x-versionadded: v2.37
        recipeId:
          description: The ID of the recipe to use as the source of data.
          type: string
        useKerberos:
          default: false
          description: If true, use kerberos authentication for database authentication.
          type: boolean
          x-versionadded: v2.37
      required:
      - recipeId
      type: object
      x-versionadded: v2.37
    DatasetCreateVersionFromWorkspaceState:
      properties:
        credentials:
          description: JDBC credentials.
          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: The ID of the workspace state to use as the source of data.
          type: string
      required:
      - workspaceStateId
      type: object
      x-versionadded: v2.34
    DatasetDefCreate:
      properties:
        credentialsId:
          description: The ID of the credentials to access the data store.
          type: string
        datasetId:
          description: The ID of the AI Catalog dataset.
          type: string
        datasetVersionId:
          default: null
          description: The version ID of the AI Catalog dataset.
          type:
          - string
          - 'null'
        name:
          default: null
          description: The name of the dataset definition.
          type:
          - string
          - 'null'
      required:
      - datasetId
      type: object
      x-versionadded: v2.37
    DatasetDefPaginatedResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of user-defined dataset definitions.
          items:
            $ref: '#/components/schemas/DatasetDefResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    DatasetDefResponse:
      properties:
        creatorUserId:
          description: The ID of the user who created the dataset definition.
          type: string
        datasetInfo:
          $ref: '#/components/schemas/DatasetInformationResponse'
        datasetProps:
          $ref: '#/components/schemas/DatasetPropsResponse'
        dynamicDatasetProps:
          $ref: '#/components/schemas/DynamicDatasetPropsResponse'
        id:
          description: The ID of the dataset definition.
          type: string
        name:
          description: The name of the dataset definition.
          type: string
      required:
      - creatorUserId
      - datasetInfo
      - datasetProps
      - dynamicDatasetProps
      - id
      - name
      type: object
      x-versionadded: v2.37
    DatasetDefVersionPaginatedResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of the dataset definition versions.
          items:
            $ref: '#/components/schemas/DatasetDefVersionResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    DatasetDefVersionResponse:
      properties:
        datasetInfo:
          $ref: '#/components/schemas/DatasetInformationResponse'
        id:
          description: The ID of the dataset definition version.
          type: string
      required:
      - datasetInfo
      - id
      type: object
      x-versionadded: v2.37
    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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        catalogVersionId:
          description: ID of the catalog item version.
          type: string
        dataSource:
          $ref: '#/components/schemas/DataSource'
        dataSources:
          description: Data source details for a JDBC dataset
          items:
            $ref: '#/components/schemas/DataSource'
          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: The 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?
          type:
          - boolean
          - 'null'
        originalIdentifier:
          description: Original identifier of the dataset if it was updated to resolve
            name conflicts.
          maxLength: 20
          minLength: 1
          type:
          - string
          - 'null'
        primaryTemporalKey:
          description: Name of the column indicating time of record creation.
          type:
          - string
          - 'null'
        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
    DatasetEvaluationRequest:
      description: Dataset evaluation.
      properties:
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset configuration for this dataset
            evaluation.
          title: evaluationDatasetConfigurationId
        evaluationName:
          description: The name of the evaluation. This name should provide context
            regarding what is being evaluated.
          maxLength: 5000
          minLength: 1
          title: evaluationName
          type: string
        insightConfiguration:
          $ref: '#/components/schemas/InsightsConfigurationWithAdditionalData'
        insightGradingCriteria:
          $ref: '#/components/schemas/InsightGradingCriteria'
        maxNumPrompts:
          default: 0
          description: The max number of prompts to evaluate.
          maximum: 5000.0
          minimum: 0.0
          title: maxNumPrompts
          type: integer
        ootbDatasetName:
          anyOf:
          - $ref: '#/components/schemas/OOTBDatasetName'
          - type: 'null'
          description: Out-of-the-box evaluation dataset name. This applies only to
            our predefined public evaluation datasets.
        promptSamplingStrategy:
          $ref: '#/components/schemas/PromptSamplingStrategy'
          default: first_n_rows
          description: The prompt sampling strategy. Controls how max_num_prompts
            are sampled.
      required:
      - evaluationName
      - insightConfiguration
      - insightGradingCriteria
      title: DatasetEvaluationRequest
      type: object
    DatasetEvaluationResponse:
      description: Dataset evaluation.
      properties:
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the dataset evaluation.
          title: errorMessage
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset configuration for this dataset
            evaluation.
          title: evaluationDatasetConfigurationId
        evaluationDatasetName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Evaluation dataset name.
          title: evaluationDatasetName
        evaluationName:
          description: The name of the evaluation. This name should provide context
            regarding what is being evaluated.
          maxLength: 5000
          minLength: 1
          title: evaluationName
          type: string
        insightConfiguration:
          $ref: '#/components/schemas/InsightsConfigurationWithAdditionalData'
        insightGradingCriteria:
          $ref: '#/components/schemas/InsightGradingCriteria'
        maxNumPrompts:
          default: 100
          description: The max number of prompts to evaluate.
          exclusiveMinimum: 0.0
          maximum: 5000.0
          title: maxNumPrompts
          type: integer
        ootbDataset:
          anyOf:
          - $ref: '#/components/schemas/OOTBDataset'
          - type: 'null'
          description: Out-of-the-box evaluation dataset. This applies only to our
            predefined public evaluation datasets.
        promptSamplingStrategy:
          $ref: '#/components/schemas/PromptSamplingStrategy'
          default: first_n_rows
          description: The prompt sampling strategy. Controls how max_num_prompts
            are sampled.
      required:
      - evaluationName
      - insightConfiguration
      - insightGradingCriteria
      - evaluationDatasetName
      title: DatasetEvaluationResponse
      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
    DatasetFeatureResponseWithDataQuality:
      properties:
        dataQualityIssues:
          description: The status of data quality issue detection.
          enum:
          - ISSUES_FOUND
          - NOT_ANALYZED
          - NO_ISSUES_FOUND
          type:
          - string
          - 'null'
        dataQualityIssuesTypes:
          description: Data quality issue types.
          items:
            description: Data quality issue type.
            enum:
            - disguised_missing_values
            - excess_zero
            - external_feature_derivation
            - few_negative_values
            - imputation_leakage
            - inconsistent_gaps
            - inliers
            - lagged_features
            - leading_trailing_zeros
            - missing_documents
            - missing_images
            - missing_values
            - multicategorical_invalid_format
            - new_series_recent_data
            - outliers
            - quantile_target_sparsity
            - quantile_target_zero_inflation
            - target_leakage
            - unusual_repeated_values
            type: string
          maxItems: 20
          type: array
        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 .
          type:
          - string
          - 'null'
        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
          type:
          - boolean
          - 'null'
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            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
        lowerQuartile:
          description: Lower quartile point of EDA sample of the feature.
          oneOf:
          - description: Lower quartile point of EDA sample of the feature.
            type: string
          - description: Lower quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
        max:
          description: Maximum value of the EDA sample of the feature.
          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
          - type: 'null'
        mean:
          description: Arithmetic mean of the EDA sample of the feature.
          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
          - type: 'null'
        median:
          description: Median of the EDA sample of the feature.
          oneOf:
          - description: Median of the EDA sample of the feature.
            type: string
          - description: Median of the EDA sample of the feature.
            type: number
          - type: 'null'
        min:
          description: Minimum value of the EDA sample of the feature.
          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
          - type: 'null'
        naCount:
          description: Number of missing values.
          type:
          - integer
          - 'null'
        name:
          description: Feature name
          type: string
        plot:
          description: Plot data based on feature values.
          items:
            $ref: '#/components/schemas/DatasetFeaturePlotDataResponse'
          type: array
          x-versionadded: v2.30
        sampleRows:
          description: The number of rows in the sample used to calculate the statistics.
          type: integer
          x-versionadded: v2.35
        stdDev:
          description: Standard deviation of EDA sample of the feature.
          oneOf:
          - description: Standard deviation of EDA sample of the feature.
            type: string
          - description: Standard deviation of EDA sample of the feature.
            type: number
          - type: 'null'
        timeSeriesEligibilityReason:
          description: why the feature is ineligible for time series projects, or
            'suitable' if it is eligible.
          type:
          - string
          - 'null'
        timeSeriesEligibilityReasonAggregation:
          description: why the feature is ineligible for aggregation, or 'suitable'
            if it is eligible.
          type:
          - string
          - 'null'
          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.
          type:
          - integer
          - 'null'
        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.
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        uniqueCount:
          description: Number of unique values.
          type:
          - integer
          - 'null'
        upperQuartile:
          description: Upper quartile point of EDA sample of the feature.
          oneOf:
          - description: Upper quartile point of EDA sample of the feature.
            type: string
          - description: Upper quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
      required:
      - datasetId
      - datasetVersionId
      - dateFormat
      - featureType
      - id
      - name
      - sampleRows
      type: object
      x-versionadded: v2.35
    DatasetFeaturelistListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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.'
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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: The number of items returned on this page.
          type: integer
        data:
          description: The list of features related to the requested dataset.
          items:
            $ref: '#/components/schemas/DatasetFeatureResponseWithDataQuality'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    DatasetFromFile:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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
    DatasetFromStage:
      properties:
        categories:
          description: An array of strings describing the intended use of the dataset.
          oneOf:
          - enum:
            - BATCH_PREDICTIONS
            - MULTI_SERIES_CALENDAR
            - PREDICTION
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - SINGLE_SERIES_CALENDAR
              - TRAINING
              type: string
            maxItems: 100
            type: array
        stageId:
          description: The ID of the data stage which will be used to create the dataset
            item & version.
          type: string
      required:
      - stageId
      type: object
      x-versionadded: v2.35
    DatasetIdentifier:
      description: Dataset identifier.
      properties:
        datasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the dataset, if any.
          title: datasetId
        datasetName:
          description: The name of the dataset.
          title: datasetName
          type: string
      required:
      - datasetName
      - datasetId
      title: DatasetIdentifier
      type: object
    DatasetInformationResponse:
      description: Information about the dataset.
      properties:
        columns:
          description: The list of the dataset column names. This field is auto-generated
            by the analysis job.
          items:
            description: Dataset column name.
            type: string
          maxItems: 1000
          minItems: 2
          type: array
        dataSourceId:
          default: null
          description: The ID of the SQL table query and the database path, this field
            is auto-generated by the analysis job.
          type:
          - string
          - 'null'
        dataStoreId:
          default: null
          description: The ID of the SQL data store, this field is auto-generated
            by the analysis job.
          type:
          - string
          - 'null'
        dialect:
          description: Source type data was retrieved from, this field is auto-generated
            by the analysis job.
          enum:
          - snowflake
          - bigquery
          - databricks
          - spark
          - postgres
          type: string
        estimatedSizePerRow:
          description: Estimated byte size per row of the dataset, this field is auto-generated
            by the analysis job.
          type: integer
        sourceSize:
          description: Total dataset byte size, this field is auto-generated by the
            analysis job.
          type: integer
        totalRows:
          description: Total rows of the dataset, this field is auto-generated by
            the analysis job.
          type: integer
        version:
          description: The version of the dataset definition information.
          type: integer
      required:
      - columns
      - dataSourceId
      - dataStoreId
      - dialect
      - estimatedSizePerRow
      - sourceSize
      - totalRows
      - version
      type: object
      x-versionadded: v2.37
    DatasetInputCreate:
      description: Dataset configuration.
      properties:
        sampling:
          $ref: '#/components/schemas/DatasetInputSampling'
          default: null
          x-versionadded: v2.33
      type: object
    DatasetInputSampling:
      description: Sampling data transformation.
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/RandomSampleArgumentsCreate'
            default: {}
          directive:
            description: The directive name.
            enum:
            - random-sample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/LimitDirectiveArguments'
          directive:
            description: The directive name.
            enum:
            - limit
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/DatetimeSampleArgumentsCreate'
            default: {}
          directive:
            description: The directive name.
            enum:
            - datetime-sample
            type: string
        required:
        - directive
        type: object
    DatasetLanguages:
      description: The names of dataset languages.
      enum:
      - Afrikaans
      - Amharic
      - Arabic
      - Assamese
      - Azerbaijani
      - Belarusian
      - Bulgarian
      - Bengali
      - Breton
      - Bosnian
      - Catalan
      - Czech
      - Welsh
      - Danish
      - German
      - Greek
      - English
      - Esperanto
      - Spanish
      - Estonian
      - Basque
      - Persian
      - Finnish
      - French
      - Western Frisian
      - Irish
      - Scottish Gaelic
      - Galician
      - Gujarati
      - Hausa
      - Hebrew
      - Hindi
      - Croatian
      - Hungarian
      - Armenian
      - Indonesian
      - Icelandic
      - Italian
      - Japanese
      - Javanese
      - Georgian
      - Kazakh
      - Khmer
      - Kannada
      - Korean
      - Kurdish
      - Kyrgyz
      - Latin
      - Lao
      - Lithuanian
      - Latvian
      - Malagasy
      - Macedonian
      - Malayalam
      - Mongolian
      - Marathi
      - Malay
      - Burmese
      - Nepali
      - Dutch
      - Norwegian
      - Oromo
      - Oriya
      - Panjabi
      - Polish
      - Pashto
      - Portuguese
      - Romanian
      - Russian
      - Sanskrit
      - Sindhi
      - Sinhala
      - Slovak
      - Slovenian
      - Somali
      - Albanian
      - Serbian
      - Sundanese
      - Swedish
      - Swahili
      - Tamil
      - Telugu
      - Thai
      - Tagalog
      - Turkish
      - Uyghur
      - Ukrainian
      - Urdu
      - Uzbek
      - Vietnamese
      - Xhosa
      - Yiddish
      - Chinese
      title: DatasetLanguages
      type: string
    DatasetListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
    DatasetPropsResponse:
      description: Dataset properties.
      properties:
        datasetId:
          description: The ID of the AI Catalog dataset.
          type: string
        datasetVersionId:
          description: The version ID of the AI Catalog dataset.
          type: string
      required:
      - datasetId
      - datasetVersionId
      type: object
      x-versionadded: v2.37
    DatasetRefresh:
      description: Schedule describing when to refresh the dataset. The smallest schedule
        allowed is daily.
      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:
            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:
            - number
            - string
          maxItems: 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:
            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:
            - number
            - string
          maxItems: 7
          type: array
        hour:
          default:
          - 0
          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:
          - 0
          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:
            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:
            - number
            - string
          maxItems: 12
          type: array
      required:
      - hour
      - minute
      type: object
    DatasetRefreshExecutionResult:
      properties:
        completedAt:
          description: UTC completion date, in RFC-3339 format.
          format: date-time
          type: string
        datasetId:
          description: The dataset ID associated with this result.
          type: string
        datasetVersionId:
          description: The dataset version ID associated with this result.
          type: string
        executionId:
          description: The result ID.
          type: string
        jobId:
          description: The job ID associated with this result.
          type: string
        message:
          description: The current status of execution.
          type: string
        startedAt:
          description: UTC start date, in RFC-3339 format.
          format: date-time
          type: string
        status:
          description: The 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.
          type:
          - string
          - 'null'
        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: The scheduled job name.
          maxLength: 256
          type: string
        schedule:
          $ref: '#/components/schemas/DatasetRefresh'
        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.
          type:
          - string
          - 'null'
        credentials:
          description: A JSON string describing the data engine queries credentials
            to use when refreshing.
          type: string
        datasetId:
          description: The 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'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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: The scheduled job name.
          maxLength: 256
          type: string
        schedule:
          $ref: '#/components/schemas/DatasetRefresh'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
    DatasetTransformListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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
          - type: 'null'
          description: The replacement in case of a failed transformation.
        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.
          type:
          - string
          - 'null'
      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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentialsFields'
          - $ref: '#/components/schemas/GcpCredentialsFields'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentialsFields'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentialsFields'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentialsFields'
          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'
          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
    DatasphereDataStreamer:
      description: Stream CSV data chunks from Datasphere using browser-datasphere
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the data source.
            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 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:
          - datasphere
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.35
    DatasphereIntake:
      description: Stream CSV data chunks from Datasphere using browser-datasphere
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the data source.
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          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:
          - datasphere
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.35
    DatasphereOutput:
      description: Saves CSV data chunks to Datasphere using browser-datasphere
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            write access to the data destination.
          type: string
        dataStoreId:
          description: The ID of the data store to connect to
          type: string
        schema:
          description: The name of the specified database schema to write output data
            to.
          type: string
        table:
          description: The name of the specified database table to write output data
            to.
          type: string
        type:
          description: The type name for this output type
          enum:
          - datasphere
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.35
    DatasphereOutputAdaptor:
      description: Saves CSV data chunks to Datasphere using browser-datasphere
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the data destination.
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The 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 output data
            to.
          type: string
        table:
          description: The name of the specified database table to write output data
            to.
          type: string
        type:
          description: The type name for this output type
          enum:
          - datasphere
          type: string
      required:
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.42
    DatetimeModelDetailsResponse:
      properties:
        backtests:
          description: information on each backtesting fold of the model
          items:
            $ref: '#/components/schemas/BacktestStatusResponse'
          type: array
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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: 0
          type: integer
          x-versionadded: v2.16
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
        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
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        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
          type:
          - number
          - 'null'
        holdoutStatus:
          description: the status of the holdout fold
          enum:
          - COMPLETED
          - INSUFFICIENT_DATA
          - HOLDOUT_BOUNDARIES_EXCEEDED
          type: string
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          type:
          - string
          - 'null'
          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 type 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 the 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: 0
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          type:
          - integer
          - 'null'
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          type:
          - string
          - 'null'
        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: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 100
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          type:
          - string
          - 'null'
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          type:
          - string
          - 'null'
        trainingInfo:
          $ref: '#/components/schemas/TrainingInfoResponse'
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          type:
          - string
          - 'null'
        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
      - blenderModels
      - blueprintId
      - effectiveFeatureDerivationWindowEnd
      - effectiveFeatureDerivationWindowStart
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - forecastWindowEnd
      - forecastWindowStart
      - frozenPct
      - hasCodegen
      - holdoutScore
      - holdoutStatus
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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:
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        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.
          type: object
          x-versionadded: v2.33
        modelCategory:
          description: Indicates the type 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 (e.g.,
            Support Vector Machine, Gradient Boosting Machine, etc.).
          type: string
          x-versionadded: v2.33
        modelNumber:
          description: The model number from the Leaderboard.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        processes:
          description: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
          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: 100
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
      required:
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      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
          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'
            - $ref: '#/components/schemas/BacktestNewMethodForOpenApi'
          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
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalLogLines:
          description: The total number of lines in feature derivation log.
          type: integer
      required:
      - count
      - datetimePartitioningLog
      - next
      - previous
      - totalLogLines
      type: object
    DatetimePartitioningResponse:
      description: Partitioning information for a datetime project.
      properties:
        aggregationType:
          description: For multiseries projects only. The aggregation type to apply
            when creating cross-series features.
          enum:
          - total
          - average
          type:
          - string
          - 'null'
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          description: Specifies whether the time series predictions can use partial
            historical data.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
          x-versionadded: v2.15
        calendarName:
          description: The name of the calendar used in this project.
          type:
          - string
          - 'null'
          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
          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
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          - 'null'
          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
          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'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.9
        unsupervisedMode:
          description: A boolean value indicating whether an unsupervised project
            should be created.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.31
        unsupervisedType:
          description: The type of unsupervised project.
          enum:
          - anomaly
          - clustering
          type:
          - string
          - 'null'
          x-versionadded: v2.31
        useCrossSeriesFeatures:
          description: For multiseries projects only. Indicating whether to use cross-series
            features.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
        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
          - 'null'
          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:
      description: The interactive sampling config.
      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.
          type:
          - string
          - 'null'
          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
          type: array
          x-versionadded: v2.33
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
        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
      - skip
      - strategy
      type: object
    DatetimeTrendPlotsBacktestMetadata:
      description: Metadata for backtest/holdout.
      properties:
        training:
          $ref: '#/components/schemas/DatetimeTrendPlotsMetadataStartEndDates'
        validation:
          $ref: '#/components/schemas/DatetimeTrendPlotsMetadataStartEndDates'
      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:
      description: Start and end dates for the backtest/holdout training.
      properties:
        endDate:
          description: The datetime of the end of the chart data (exclusive). Null
            if chart data is not computed.
          format: date-time
          type:
          - string
          - 'null'
        startDate:
          description: The datetime of the start of the chart data (inclusive). Null
            if chart data is not computed.
          format: date-time
          type:
          - string
          - 'null'
      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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        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
    DefaultEnvironment:
      description: Specifies the default environment for the custom template.
      properties:
        environmentId:
          description: The ID the environment to use for the public custom metric
            image.
          type: string
        environmentVersionId:
          description: The ID of the specific environment version to use with the
            public custom metric image.
          type: string
      required:
      - environmentId
      - environmentVersionId
      type: object
      x-versionadded: v2.36
    DeleteFilesOrFolders:
      properties:
        paths:
          description: File and folder paths to delete. Folder paths should end with
            slash '/'.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
      required:
      - paths
      type: object
      x-versionadded: v2.42
    DeleteFilesOrFoldersResponse:
      properties:
        catalogId:
          description: The ID of the catalog item.
          type: string
        catalogVersionId:
          description: The ID of the catalog version item.
          type: string
        numFiles:
          description: The new number of files in the file entity.
          type: integer
        results:
          description: The number of files deleted for each path provided.
          items:
            $ref: '#/components/schemas/DeletedFilesCountPerPathItemResponse'
          maxItems: 1000
          type: array
      required:
      - catalogId
      - catalogVersionId
      - numFiles
      - results
      type: object
      x-versionadded: v2.42
    DeleteFilesystemObjectsRequest:
      description: Delete filesystem object request schema.
      properties:
        paths:
          description: List of paths to delete.
          items:
            type: string
          title: Paths
          type: array
      title: DeleteFilesystemObjectsRequest
      type: object
    DeleteScheduledJobQuery:
      description: Query parameters for deleting a scheduled job.
      properties:
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      required:
      - useCaseId
      title: DeleteScheduledJobQuery
      type: object
    DeleteSearchApiResponse:
      description: API response for the deletion of a search study.
      properties:
        jobId:
          description: The ID of the worker job.
          format: uuid4
          title: jobId
          type: string
        searchStudyId:
          description: The ID of the search study.
          title: searchStudyId
          type: string
      required:
      - searchStudyId
      - jobId
      title: DeleteSearchApiResponse
      type: object
    DeletedDeploymentListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of deleted deployments.
          items:
            $ref: '#/components/schemas/DeletedDeploymentResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      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
    DeletedFilesCountPerPathItemResponse:
      properties:
        numFilesDeleted:
          description: The number of files that were deleted for the path.
          type: integer
        path:
          description: The file or folder path that was deleted.
          type: string
      required:
      - numFilesDeleted
      - path
      type: object
      x-versionadded: v2.42
    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: The number of items returned on this page.
          type: integer
        data:
          description: List of deleted projects
          items:
            $ref: '#/components/schemas/DeletedProjectResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    DeletedProjectOrganization:
      description: The organization the project belongs to
      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'
        deletedBy:
          $ref: '#/components/schemas/DeletedProjectUser'
        deletionTime:
          description: ISO-8601 formatted date when project was deleted
          format: date-time
          type:
          - string
          - 'null'
        fileName:
          description: The name of the file uploaded for the project dataset
          type:
          - string
          - 'null'
        id:
          description: The ID of the project
          type: string
        organization:
          $ref: '#/components/schemas/DeletedProjectOrganization'
        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:
      description: The user who created the project
      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'
          maxItems: 100
          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
    Deployment:
      description: The deployment associated to the custom metric.
      properties:
        createdAt:
          description: Timestamp when the deployment was created.
          format: date-time
          type: string
        creatorFirstName:
          description: First name of the deployment creator.
          type:
          - string
          - 'null'
        creatorGravatarHash:
          description: Gravatar hash of the deployment creator.
          type:
          - string
          - 'null'
        creatorLastName:
          description: Last name of the deployment creator.
          type:
          - string
          - 'null'
        creatorUsername:
          description: Username of the deployment creator.
          type:
          - string
          - 'null'
        id:
          description: The ID of the deployment.
          type: string
        name:
          description: Name of the deployment.
          type: string
      required:
      - createdAt
      - creatorFirstName
      - creatorGravatarHash
      - creatorLastName
      - creatorUsername
      - id
      - name
      type: object
      x-versionadded: v2.34
    DeploymentAccessData:
      description: Add authorization_header to avoid breaking change to API.
      properties:
        authorizationHeader:
          default: '[REDACTED]'
          description: The `Authorization` header to use for the deployment.
          title: authorizationHeader
          type: string
        chatApiUrl:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL of the deployment's chat API.
          title: chatApiUrl
        datarobotKey:
          anyOf:
          - type: string
          - type: 'null'
          description: The server key associated with the prediction API.
          title: datarobotKey
        inputType:
          $ref: '#/components/schemas/DeploymentInputType'
          description: The format of the input data.
        modelType:
          $ref: '#/components/schemas/SupportedDeploymentType'
          description: The type of the target output the deployment produces.
        predictionApiUrl:
          description: The URL of the deployment's prediction API.
          title: predictionApiUrl
          type: string
      required:
      - predictionApiUrl
      - datarobotKey
      - inputType
      - modelType
      title: DeploymentAccessData
      type: object
    DeploymentAccuracyHealthResponse:
      description: Accuracy health of the deployment.
      properties:
        endDate:
          description: End date of accuracy health period.
          format: date-time
          type:
          - string
          - 'null'
        message:
          description: A message providing more detail on the status.
          type: string
        startDate:
          description: Start date of accuracy health period.
          format: date-time
          type:
          - string
          - 'null'
        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
    DeploymentAndGuardResponse:
      properties:
        configurationId:
          description: ID of guard configuration.
          type: string
        deploymentId:
          description: ID of guard model deployment.
          type: string
        name:
          description: Name of guard configuration.
          type: string
      required:
      - configurationId
      - deploymentId
      - name
      type: object
      x-versionadded: v2.35
    DeploymentApproveChange:
      description: Approve a deployment.
      properties:
        approvalStatus:
          description: Deployment approval status to set.
          enum:
          - APPROVED
          type: string
      required:
      - approvalStatus
      type: object
    DeploymentCapabilitiesRetrieveResponse:
      properties:
        data:
          description: The 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: Whether the capability is supported.
          type: boolean
      required:
      - messages
      - name
      - supported
      type: object
    DeploymentChangeImportanceChange:
      description: Change deployment importance.
      properties:
        importance:
          description: Deployment Importance to set.
          enum:
          - CRITICAL
          - HIGH
          - MODERATE
          - LOW
          type: string
      required:
      - importance
      type: object
    DeploymentChangeStatusChange:
      description: Change deployment status.
      properties:
        status:
          description: Deployment status to set.
          enum:
          - active
          - inactive
          type: string
      required:
      - status
      type: object
    DeploymentChecklistResponse:
      properties:
        data:
          description: The list of settings for the deployment.
          items:
            $ref: '#/components/schemas/SingleDeploymentSetting'
          maxItems: 12
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.38
    DeploymentCleanupStatsChange:
      description: Cleanup deployment stats.
      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
          type:
          - string
          - 'null'
        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``.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      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
          type:
          - string
          - 'null'
        grantInitialDeploymentRolesFromProject:
          default: true
          description: If True, initial roles on the deployment will be granted to
            users who have roles on the project that the deployed model comes from.
            If False, only the creator of the deployment will be given a role on the
            deployment. Defaults to True.
          type: boolean
          x-versionadded: v2.31
        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
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.23
      required:
      - description
      - label
      - modelId
      type: object
    DeploymentCreateFromModelPackage:
      properties:
        additionalMetadata:
          description: Key/Value pair list, with additional metadata
          items:
            $ref: '#/components/schemas/KeyValuePair'
          maxItems: 40
          type: array
        defaultPredictionServerId:
          description: ID of the default prediction server for deployment. Required
            for DataRobot Cloud for non-external models, must be omitted for Enterprise
            installations.
          type: string
        description:
          default: null
          description: A description for the deployment.
          maxLength: 10000
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        label:
          description: A human-readable name for the deployment.
          maxLength: 512
          type: string
        modelPackageId:
          description: ID of the model package to deploy.
          type: string
        predictionEnvironmentId:
          description: ID of prediction environment where to deploy
          type: string
        runtimeParameterValues:
          description: "Inject values into a model at runtime. The fieldName must\
            \ match a fieldName defined in the model package. This list is merged\
            \ with any existing runtime values set through the deployed model package.\n\
            \                    <blockquote>This property is gated behind the feature\
            \ flags **`['CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT']`**.\n\
            \                    To enable this feature, you can contact your DataRobot\
            \ representative or administrator.\n                    </blockquote>"
          feature_flags:
          - &id001
            description: Enables the ability to edit Custom Model Runtime-Parameters
              (and replica and resource bundle settings) directly from the Deployment
              info page. Edited values are local to a given Deployment and do not
              affect the runtime of any current or future Deployments of the same
              Model Package.
            enabled_by_default: true
            maturity: PUBLIC_PREVIEW
            name: CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT
          public_preview: true
          type: string
          x-datarobot-public-preview: true
          x-datarobot-required-feature-flags:
          - *id001
        status:
          default: active
          description: Status of the deployment
          enum:
          - active
          - inactive
          type:
          - string
          - 'null'
          x-versionadded: v2.23
        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:
      - description
      - label
      - modelPackageId
      type: object
      x-versionadded: v2.37
    DeploymentCreateResponse:
      properties:
        id:
          description: The ID of the created deployment.
          type: string
      required:
      - id
      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.
          type:
          - string
          - 'null'
        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:
      description: The prediction server associated with the deployment.
      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.
          type:
          - string
          - 'null'
        url:
          description: URL of the prediction server.
          type: string
      required:
      - datarobot-key
      - id
      - url
      type: object
    DeploymentDeleteChange:
      description: Delete a deployment.
      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
    DeploymentGetLimitsResponse:
      properties:
        maxDeploymentLimit:
          $ref: '#/components/schemas/LimitInfo'
        prepaidDeploymentLimit:
          $ref: '#/components/schemas/LimitInfo'
        totalDeploymentCount:
          description: Total number of deployments counted for limit information.
          type: integer
      required:
      - maxDeploymentLimit
      - prepaidDeploymentLimit
      - totalDeploymentCount
      type: object
      x-versionadded: v2.43
    DeploymentGovernanceResponse:
      description: Deployment governance info.
      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
        reviewers:
          description: A list of reviewers to approve deployment change requests.
          items:
            $ref: '#/components/schemas/DeploymentReviewerResponse'
          maxItems: 20
          type: array
          x-versionadded: v2.37
      required:
      - approvalStatus
      - hasOpenedChangeRequests
      type: object
    DeploymentInputType:
      description: The format of the input data submitted to a DataRobot deployment.
      enum:
      - CSV
      - JSON
      title: DeploymentInputType
      type: string
    DeploymentListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of deployments.
          items:
            $ref: '#/components/schemas/DeploymentRetrieveResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DeploymentModelCustomModelImageResponse:
      description: Information related to the custom model image of the deployment.
      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:
      description: Model health of the deployment.
      properties:
        endDate:
          description: End date of model health period.
          format: date-time
          type:
          - string
          - 'null'
        message:
          description: A message providing more detail on the status.
          type: string
        startDate:
          description: Start date of model health period.
          format: date-time
          type:
          - string
          - 'null'
        status:
          description: Model health status.
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    DeploymentModelPackageInitialDownloadResponse:
      description: If a model package has been downloaded for this deployment, then
        this will tell you when it was first downloaded.
      properties:
        timestamp:
          description: Timestamp of the first time model package was downloaded.
          format: date-time
          type:
          - string
          - 'null'
      required:
      - timestamp
      type: object
    DeploymentModelPackageResponse:
      description: Information related to the current ModelPackage.
      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
          type:
          - string
          - 'null'
      required:
      - id
      - name
      - registeredModelId
      type: object
    DeploymentModelResponse:
      description: Information related to the current model of the deployment.
      properties:
        buildEnvironmentType:
          description: Build environment type of the current model.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        customModelImage:
          $ref: '#/components/schemas/DeploymentModelCustomModelImageResponse'
        deployedAt:
          description: Timestamp of when current model was deployed.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        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.
          type:
          - string
          - 'null'
        projectName:
          description: Project name of the current model.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.23
      required:
      - id
      - isDeprecated
      - projectName
      - targetType
      - type
      - unstructuredModelKind
      - unsupervisedMode
      type: object
    DeploymentOwnerResponse:
      description: Creator of the deployment.
      properties:
        email:
          description: Email address of the owner.
          type:
          - string
          - 'null'
        firstName:
          description: First name of the owner.
          type:
          - string
          - 'null'
        id:
          description: ID of the owner.
          type: string
        lastName:
          description: Last name of the owner.
          type:
          - string
          - 'null'
      required:
      - email
      - firstName
      - id
      - lastName
      type: object
    DeploymentOwnersResponse:
      description: Count and preview of owners of the deployment.
      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
    DeploymentPagination:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of deployments linked to a use case.
          items:
            $ref: '#/components/schemas/FormattedResponseDeployment'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    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:
      description: Information related to the current PredictionEnvironment.
      properties:
        id:
          description: ID of the PredictionEnvironment.
          type:
          - string
          - 'null'
        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
          - sapAiCore
          type: string
        plugin:
          description: Plugin name of the PredictionEnvironment.
          type:
          - string
          - 'null'
        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
    DeploymentPredictionEnvironmentUpdate:
      properties:
        dpsDeploymentId:
          description: The ID of the deployment on dedicated prediction environment
            that will be updated to serverless.
          type: string
        serverlessPredictionEnvironmentId:
          description: The ID of serverless prediction environment.
          type: string
      required:
      - dpsDeploymentId
      - serverlessPredictionEnvironmentId
      type: object
      x-versionadded: v2.38
    DeploymentPredictionUsageResponse:
      description: Prediction usage of the deployment.
      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
          type:
          - string
          - 'null'
        serverErrorRates:
          description: Number of server errors (5xx) in the last 7 days.
          items:
            type: integer
          maxItems: 7
          type: array
          x-versionadded: v2.39
        userErrorRates:
          description: Number of user errors (4xx) in the last 7 days.
          items:
            type: integer
          maxItems: 7
          type: array
          x-versionadded: v2.39
      required:
      - dailyRates
      - lastTimestamp
      - serverErrorRates
      - userErrorRates
      type: object
    DeploymentReplaceModelChange:
      description: Replace model in deployment.
      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:
      description: Replace model package in deployment.
      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'
        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
        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
        creator:
          $ref: '#/components/schemas/DeploymentOwnerResponse'
          x-versionadded: v2.37
        defaultPredictionServer:
          $ref: '#/components/schemas/DeploymentDefaultPredictionServerResponse'
        description:
          description: Description of the deployment.
          type:
          - string
          - 'null'
        governance:
          $ref: '#/components/schemas/DeploymentGovernanceResponse'
          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'
        modelHealth:
          $ref: '#/components/schemas/DeploymentModelHealthResponse'
        modelPackage:
          $ref: '#/components/schemas/DeploymentModelPackageResponse'
          x-versionadded: v2.23
        modelPackageInitialDownload:
          $ref: '#/components/schemas/DeploymentModelPackageInitialDownloadResponse'
          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'
        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'
          x-versionadded: v2.23
        predictionUsage:
          $ref: '#/components/schemas/DeploymentPredictionUsageResponse'
        scoringCodeInitialDownload:
          $ref: '#/components/schemas/DeploymentScoringCodeInitialDownloadResponse'
          x-versionadded: v2.21
        serviceHealth:
          $ref: '#/components/schemas/DeploymentServiceHealthResponse'
        settings:
          $ref: '#/components/schemas/DeploymentSettingsInfo'
          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
      - createdAt
      - defaultPredictionServer
      - description
      - id
      - label
      - model
      - modelHealth
      - permissions
      - predictionUsage
      - serviceHealth
      - settings
      - status
      - tags
      type: object
    DeploymentReviewerResponse:
      properties:
        email:
          description: The email address of the reviewer.
          type:
          - string
          - 'null'
        fullName:
          description: The full name of the reviewer.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        id:
          description: The ID of the reviewer.
          type: string
        status:
          description: The latest review status.
          enum:
          - APPROVED
          - CHANGES_REQUESTED
          - COMMENTED
          type:
          - string
          - 'null'
        userhash:
          description: Reviewer's gravatar hash.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        username:
          description: The username of the reviewer.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
      required:
      - email
      - id
      - status
      type: object
      x-versionadded: v2.37
    DeploymentScoringCodeInitialDownloadResponse:
      description: If scoring code has been downloaded for this deployment, then this
        will tell you when it was first downloaded.
      properties:
        timestamp:
          description: Timestamp of the first time scoring code was downloaded.
          format: date-time
          type:
          - string
          - 'null'
      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:
      description: Service health of the deployment.
      properties:
        endDate:
          description: End date of model service period.
          format: date-time
          type:
          - string
          - 'null'
        startDate:
          description: Start date of service health period.
          format: date-time
          type:
          - string
          - 'null'
        status:
          description: Service health status.
          enum:
          - failing
          - notStarted
          - passing
          - unavailable
          - unknown
          - warning
          type: string
      required:
      - endDate
      - startDate
      - status
      type: object
    DeploymentSettingsInfo:
      description: Settings of the deployment.
      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'
          x-versionadded: v2.19
        automaticActuals:
          $ref: '#/components/schemas/AutomaticActuals'
          x-versionadded: v2.25
        biasAndFairness:
          $ref: '#/components/schemas/BiasAndFairness'
          x-versionadded: v2.31
        challengerModels:
          $ref: '#/components/schemas/Challengers'
          x-versionadded: v2.23
        featureDrift:
          $ref: '#/components/schemas/FeatureDriftSetting'
        humility:
          $ref: '#/components/schemas/Humility'
          x-versionadded: v2.21
        predictionIntervals:
          $ref: '#/components/schemas/PredictionIntervals'
          x-versionadded: v2.19
        predictionWarning:
          $ref: '#/components/schemas/PredictionWarning'
          x-versionadded: v2.19
        predictionsByForecastDate:
          $ref: '#/components/schemas/PredictionsByForecastDate'
          x-versionadded: v2.23
        predictionsDataCollection:
          $ref: '#/components/schemas/PredictionsDataCollection'
          x-versionadded: v2.19
        processingLimits:
          $ref: '#/components/schemas/ProcessingLimits'
          x-versionadded: v2.34
        segmentAnalysis:
          $ref: '#/components/schemas/SegmentAnalysis'
          x-versionadded: v2.20
        targetDrift:
          $ref: '#/components/schemas/TargetDriftSetting'
      required:
      - associationId
      - featureDrift
      - predictionIntervals
      - targetDrift
      type: object
    DeploymentSettingsUpdate:
      properties:
        associationId:
          $ref: '#/components/schemas/AssociationID'
          x-versionadded: v2.19
        automaticActuals:
          $ref: '#/components/schemas/AutomaticActuals'
          x-versionadded: v2.25
        biasAndFairness:
          $ref: '#/components/schemas/BiasAndFairness'
          x-versionadded: v2.31
        challengerModels:
          $ref: '#/components/schemas/Challengers'
          x-versionadded: v2.23
        featureDrift:
          $ref: '#/components/schemas/FeatureDriftSetting'
        humility:
          $ref: '#/components/schemas/Humility'
          x-versionadded: v2.21
        predictionIntervals:
          $ref: '#/components/schemas/PredictionIntervals'
          x-versionadded: v2.19
        predictionWarning:
          $ref: '#/components/schemas/PredictionWarning'
          x-versionadded: v2.19
        predictionsByForecastDate:
          $ref: '#/components/schemas/PredictionsByForecastDate'
          x-versionadded: v2.23
        predictionsDataCollection:
          $ref: '#/components/schemas/PredictionsDataCollection'
          x-versionadded: v2.19
        processingLimits:
          $ref: '#/components/schemas/ProcessingLimits'
          x-versionadded: v2.34
        segmentAnalysis:
          $ref: '#/components/schemas/SegmentAnalysis'
          x-versionadded: v2.20
        targetDrift:
          $ref: '#/components/schemas/TargetDriftSetting'
      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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      type: object
    DeploymentUpdateSecondaryDatasetConfigChange:
      description: Update secondary dataset config for deployment.
      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'
          x-versionadded: v2.31
        holdoutData:
          $ref: '#/components/schemas/DeprecatedHoldoutDataAssignment'
          x-versionadded: v2.30
          x-versiondeprecated: v2.33
        trainingData:
          $ref: '#/components/schemas/DeprecatedTrainingDataForVersionsAssignment'
          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).
          type:
          - string
          - 'null'
        created:
          description: ISO-8601 timestamp of when the file item was created.
          type: string
        fileName:
          description: The name of the file item.
          type: string
        filePath:
          description: The path of the file item.
          type: string
        fileSource:
          description: The 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.
          type:
          - string
          - 'null'
        repositoryFilePath:
          description: Full path to the file in the remote repository.
          type:
          - string
          - 'null'
        repositoryLocation:
          description: URL to remote repository from which the file was pulled (e.g.
            Git server or S3 Bucket name).
          type:
          - string
          - 'null'
        repositoryName:
          description: Name of the repository from which the file was pulled.
          type:
          - string
          - 'null'
        storagePath:
          description: Storage path of the file item.
          type: string
          x-versiondeprecated: '2.25'
        workspaceId:
          description: The workspace ID of the file item.
          type: string
          x-versiondeprecated: '2.25'
      required:
      - created
      - fileName
      - filePath
      - fileSource
      - id
      - storagePath
      - workspaceId
      type: object
    DeprecatedHoldoutDataAssignment:
      description: Holdout data configuration.
      properties:
        datasetId:
          description: The ID of the dataset.
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        datasetVersionId:
          description: The ID of the dataset version.
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        partitionColumn:
          description: The name of the column containing the partition assignments.
          maxLength: 500
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.33
      type: object
    DeprecatedTrainingDataForModelsAssignment:
      properties:
        datasetId:
          description: The ID of the dataset.
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        datasetVersionId:
          description: The ID of the dataset version.
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        partitionColumn:
          description: The name of the column containing the partition assignments.
          maxLength: 500
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
      type: object
    DeprecatedTrainingDataForVersionsAssignment:
      description: Training data configuration.
      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.
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versiondeprecated: v2.34
        datasetVersionId:
          description: The ID of the dataset version.
          type:
          - string
          - 'null'
          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
    DetectUdfs:
      properties:
        credentialId:
          description: The ID of the set of credentials to use instead of username
            and password.
          type: string
        force:
          default: false
          description: Forces detection to be submitted, even if a cache with detected
            standard user-defined functions for given parameters is already present.
          type: boolean
        functionType:
          description: The standard user-defined function type.
          enum:
          - rolling_median
          - rolling_most_frequent
          type: string
        schema:
          description: The schema to create or detect user-defined functions in.
          type: string
      required:
      - force
      - functionType
      - schema
      type: object
      x-versionadded: v2.36
    DetectedStandardUdfsRetrieveResponse:
      properties:
        detectedFunctions:
          description: The detected standard user-defined functions.
          items:
            type: string
          maxItems: 1000
          type: array
        functionType:
          description: The requested standard user-defined function type.
          type: string
        schema:
          description: The requested schema.
          type: string
      required:
      - detectedFunctions
      - functionType
      - schema
      type: object
      x-versionadded: v2.36
    DirHierarchyObjectSchema:
      description: 'These are only directories


        The name property can be any string or the constant/sentinel "root"'
      properties:
        name:
          anyOf:
          - type: string
          - enum:
            - root
            type: string
          description: Name of the directory.
          title: Name
        path:
          description: Path to the directory.
          title: Path
          type: string
      required:
      - name
      - path
      title: DirHierarchyObjectSchema
      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
    DisplayDataOutputSchema:
      description: The schema for the display data output in a notebook cell.
      properties:
        data:
          additionalProperties:
            anyOf:
            - type: string
            - items:
                type: string
              type: array
            - {}
          description: Data of the output.
          title: Data
          type: object
        metadata:
          description: Metadata of the output.
          title: Metadata
          type: object
        outputType:
          const: display_data
          default: display_data
          description: Type of the output.
          title: Outputtype
          type: string
      title: DisplayDataOutputSchema
      type: object
    DistanceMetric:
      description: Distance metrics for vector databases.
      enum:
      - cosine
      - dot_product
      - euclidean
      - inner_product
      - manhattan
      title: DistanceMetric
      type: string
    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.
          type:
          - number
          - 'null'
        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
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
          - type: 'null'
        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'
        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
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
          - type: 'null'
        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'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DocumentTextExtractionSamplesRetrieveDocumentsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A list of documents.
          items:
            $ref: '#/components/schemas/DocumentTextExtractionDocumentElement'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        targetBins:
          description: List of bin objects for regression or null
          items:
            $ref: '#/components/schemas/TargetBin'
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          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: The number of items returned on this page.
          type: integer
        data:
          description: List of document pages
          items:
            $ref: '#/components/schemas/DocumentTextExtractionPagesElement'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        targetBins:
          description: List of bin objects for regression or null
          items:
            $ref: '#/components/schemas/TargetBin'
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DocumentThumbnailMetadataListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
        targetBinRowCount:
          description: The number of rows in the target bin.
          type: integer
        targetBinStart:
          description: Target value for bin start for regression, null for classification
          type:
          - integer
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DownloadFilesystemObjectsQuery:
      description: Query schema for downloading filesystem objects.
      properties:
        paths:
          description: List of paths to download.
          items:
            type: string
          title: Paths
          type: array
      title: DownloadFilesystemObjectsQuery
      type: object
    DownloadFilesystemObjectsRequest:
      description: Query schema for downloading filesystem objects.
      properties:
        paths:
          description: List of paths to download.
          items:
            type: string
          title: Paths
          type: array
      title: DownloadFilesystemObjectsRequest
      type: object
    DownsamplingRandomDirectiveArguments:
      description: The downsampling configuration.
      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
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - rows
      - skip
      type: object
    DrApiTokenEnvironmentVariable:
      description: 'A platform-managed DataRobot API token injected as an environment
        variable.

        The token value is resolved at proton creation (find-or-create a per-workload

        ``Workload <workloadId>`` API key scoped to the invoking user); no value or
        id

        is supplied by the user.'
      properties:
        name:
          description: Name of the environment variable
          title: Name
          type: string
        source:
          const: dr-api-token
          title: Source
          type: string
      required:
      - source
      - name
      title: DrApiTokenEnvironmentVariable
      type: object
    DriftBatch:
      description: Info of the batch associated with the bucket.
      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
          type:
          - string
          - 'null'
          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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DriverConfigurationRetrieveResponse:
      properties:
        associatedAuthTypes:
          description: The 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: The user ID of the creator of this configuration.
          type: string
        id:
          description: The 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: The 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: The 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
          type: array
        canonicalName:
          description: User-friendly driver name.
          type: string
        className:
          description: Driver class name. For example 'com.amazon.redshift.jdbc.Driver'
          type:
          - string
          - 'null'
        configurationId:
          description: Driver configuration ID if it was provided during driver upload.
          type:
          - string
          - 'null'
          x-versionadded: v2.18
        creator:
          description: The 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
          - datasphere-v1
          - salesforce-v1
          - trino-v1
          type:
          - string
          - 'null'
          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:
      description: The transformation description.
      properties:
        columns:
          description: The list of columns.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
        keepColumns:
          default: false
          description: If True, keep only the specified columns. If False (default),
            drop the specified columns.
          type: boolean
          x-versionadded: v2.37
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - columns
      - skip
      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: The number of items returned on this page.
          type: integer
        data:
          description: List of image metadata
          items:
            $ref: '#/components/schemas/DuplicateImageItem'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    DynamicDatasetPropsResponse:
      description: Dynamic dataset additional properties.
      properties:
        credentialsId:
          default: null
          description: The ID of the credentials to access the data store.
          type:
          - string
          - 'null'
      required:
      - credentialsId
      type: object
      x-versionadded: v2.37
    EditChatPromptRequest:
      description: The body of the "Update chat prompt" request.
      properties:
        customMetrics:
          anyOf:
          - items:
              $ref: '#/components/schemas/MetricMetadata'
            type: array
          - type: 'null'
          description: The list of metric results to add to the chat prompt.
          title: customMetrics
        feedbackMetadata:
          anyOf:
          - $ref: '#/components/schemas/FeedbackMetadata'
          - type: 'null'
          description: The feedback metadata to add to the chat prompt.
      title: EditChatPromptRequest
      type: object
    EditChatRequest:
      description: The body of the "Edit chat" request.
      properties:
        name:
          description: The new name of the chat.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
      required:
      - name
      title: EditChatRequest
      type: object
    EditComparisonChatRequest:
      description: The body of the "Edit comparison chat" request.
      properties:
        name:
          description: The new name of the comparison chat.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
      required:
      - name
      title: EditComparisonChatRequest
      type: object
    EditComparisonPromptRequest:
      description: The body of the "Edit comparison prompt" request.
      properties:
        additionalLLMBlueprintIds:
          default: []
          description: The list of additional LLM blueprint IDs that should execute
            this comparison prompt.
          items:
            type: string
          maxItems: 10
          title: additionalLLMBlueprintIds
          type: array
        feedbackResult:
          anyOf:
          - $ref: '#/components/schemas/ComparisonPromptFeedbackResult'
          - type: 'null'
          description: The feedback information to add to the comparison prompt.
      title: EditComparisonPromptRequest
      type: object
    EditCostMetricConfigurationRequest:
      description: The body of the "Edit cost metric configuration" request.
      properties:
        costMetricConfigurations:
          description: The list of LLM cost configurations to apply to this cost metric
            configuration.
          items:
            $ref: '#/components/schemas/LLMCostConfigurationResponse'
          minItems: 1
          title: costMetricConfigurations
          type: array
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The name to use for the cost configuration.
          title: name
      required:
      - costMetricConfigurations
      title: EditCostMetricConfigurationRequest
      type: object
    EditCustomModelValidationRequest:
      description: The body of the "Edit custom model validation" request.
      properties:
        chatModelId:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The model ID to specify when calling the OpenAI chat completion
            API of the deployment. If this parameter is specified, the deployment
            must support the OpenAI chat completion API.
          title: chatModelId
        deploymentId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, changes the ID of the deployment associated with
            this custom model validation.
          title: deploymentId
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, changes the ID of the model associated with this
            custom model validation.
          title: modelId
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: If specified, renames the custom model validation to this value.
          title: name
        predictionTimeout:
          anyOf:
          - maximum: 600.0
            minimum: 1.0
            type: integer
          - type: 'null'
          description: If specified, sets the timeout in seconds for the prediction
            when validating a custom model.
          title: predictionTimeout
        promptColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the name of the column that will be used
            to format the prompt text input for the custom model deployment.
          title: promptColumnName
        targetColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the name of the column that will be used
            to extract the prediction response from the custom model deployment.
          title: targetColumnName
      title: EditCustomModelValidationRequest
      type: object
    EditEvaluationDatasetConfigurationRequest:
      description: The body of the "Edit evaluation dataset configuration" request.
      properties:
        agentGoalsColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: If specified, changes the expected name of the dataset column
            containing expected agent goals. It is required to evaluate the AgentGoalAccuracyWithReference
            metric for agentic workflows.
          title: agentGoalsColumnName
        correctnessEnabled:
          anyOf:
          - type: boolean
          - type: 'null'
          deprecated: true
          description: If specified, enables or disables correctness for the evaluation
            dataset configuration.
          title: correctnessEnabled
        datasetId:
          default: '000000000000000000000000'
          description: If specified, updates the ID of the evaluation dataset.
          title: datasetId
          type: string
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, renames the evaluation dataset configuration
            to this value.
          title: name
        promptColumnName:
          default: None
          description: If specified, changes the expected name of the dataset column
            containing the prompt text.
          maxLength: 5000
          minLength: 1
          title: promptColumnName
          type: string
        responseColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: If specified, changes the expected name of the dataset column
            containing the response text.
          title: responseColumnName
        toolCallsColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: If specified, changes the expected name of the dataset column
            containing expected tool calls. It is required to evaluate the ToolCallAccuracy
            metric for agentic workflows.
          title: toolCallsColumnName
      title: EditEvaluationDatasetConfigurationRequest
      type: object
    EditLLMTestConfigurationRequest:
      description: Request object for editing a LLMTestConfiguration.
      properties:
        datasetEvaluations:
          anyOf:
          - items:
              $ref: '#/components/schemas/DatasetEvaluationRequest'
            maxItems: 10
            minItems: 1
            type: array
          - type: 'null'
          description: New Dataset evaluations.
          title: datasetEvaluations
        description:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: New LLM test configuration description.
          title: description
        llmTestGradingCriteria:
          anyOf:
          - $ref: '#/components/schemas/LLMTestGradingCriteria'
          - type: 'null'
          description: New LLM test grading criteria.
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: New LLM test configuration name.
          title: name
      title: EditLLMTestConfigurationRequest
      type: object
    EditLLMTestSuiteRequest:
      description: The body of the "Edit LLM test suite" request.
      properties:
        description:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The description of the LLM test suite.
          title: description
        llmTestConfigurationIds:
          anyOf:
          - items:
              type: string
            maxItems: 100
            type: array
          - type: 'null'
          description: The IDs of the LLM test configurations in the LLM test suite.
          title: llmTestConfigurationIds
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The name of the LLM test suite.
          title: name
      title: EditLLMTestSuiteRequest
      type: object
    EditPlaygroundRequest:
      description: The body of the Edit Playground request.
      properties:
        description:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, updates the playground description to this value.
          title: description
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, renames the playground to this value.
          title: name
      title: EditPlaygroundRequest
      type: object
    EditSearchStudyRequest:
      description: The body of the "Edit search study" request.
      properties:
        name:
          description: The new name of the search study.
          maxLength: 5000
          minLength: 1
          title: name
          type: string
      required:
      - name
      title: EditSearchStudyRequest
      type: object
    EditSidecarModelMetricValidationRequest:
      description: The body of the "Edit sidecar model metric validation" request.
      properties:
        chatModelId:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: The model ID to specify when calling the OpenAI chat completion
            API of the deployment. If this parameter is specified, the deployment
            must support the OpenAI chat completion API.
          title: chatModelId
        citationsPrefixColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the column name prefix that will be used
            to submit the citation inputs to the sidecar model.
          title: citationsPrefixColumnName
        deploymentId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, changes the ID of the deployment associated with
            this custom model validation.
          title: deploymentId
        expectedResponseColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the name of the column that will be used
            to submit the expected response text input to the sidecar model.
          title: expectedResponseColumnName
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, changes the ID of the model associated with this
            custom model validation.
          title: modelId
        moderationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration to be associated with the sidecar
            model metric.
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: If specified, renames the custom model validation to this value.
          title: name
        predictionTimeout:
          anyOf:
          - maximum: 600.0
            minimum: 1.0
            type: integer
          - type: 'null'
          description: If specified, sets the timeout in seconds for the prediction
            when validating a custom model.
          title: predictionTimeout
        promptColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the name of the column that will be used
            to format the prompt text input for the custom model deployment.
          title: promptColumnName
        responseColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the name of the column that will be used
            to submit the response text input to the sidecar model.
          title: responseColumnName
        targetColumnName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, changes the name of the column that will be used
            to extract the prediction response from the custom model deployment.
          title: targetColumnName
      title: EditSidecarModelMetricValidationRequest
      type: object
    EditVectorDatabaseRequest:
      description: The body of the "Edit vector database" request.
      properties:
        credentialId:
          anyOf:
          - type: string
          - type: 'null'
          description: The new ID of the credential to access a connected vector database.
          title: credentialId
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The new name of the vector database.
          title: name
      title: EditVectorDatabaseRequest
      type: object
    EfficientRowBasedSampleArgumentsCreate:
      description: The sampling config.
      properties:
        samplingMethod:
          default: rows
          description: The sampling method. If the sampling method is "rows", the
            size is the number of rows to be sampled. If the sampling method is "percent",
            the size is the percent of the table to be sampled.
          enum:
          - percent
          - rows
          type: string
        seed:
          default: 0
          description: The starting value used to initialize the pseudo random number
            generator.
          minimum: 0
          type: integer
        size:
          description: The number of rows or percent of the table to be sampled. The
            value is dependent on the sampling method.
          minimum: 0.01
          type: number
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
      required:
      - samplingMethod
      - skip
      type: object
      x-versionadded: v2.38
    ElasticsearchConnection:
      description: Elasticsearch vector database connection.
      properties:
        cloudId:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The cloud ID of the elastic search connection.
          title: cloudId
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        type:
          const: elasticsearch
          default: elasticsearch
          description: The type of the external vector database.
          title: type
          type: string
        url:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The URL of the elastic search connection.
          title: url
      required:
      - credentialId
      title: ElasticsearchConnection
      type: object
    ElasticsearchConnectionRequest:
      description: Elasticsearch vector database connection.
      properties:
        cloudId:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The cloud ID of the elastic search connection.
          title: cloudId
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        type:
          const: elasticsearch
          default: elasticsearch
          description: The type of the external vector database.
          title: type
          type: string
        url:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The URL of the elastic search connection.
          title: url
      required:
      - credentialId
      title: ElasticsearchConnectionRequest
      type: object
    EmbeddingModel:
      description: API response object for a single embedding model.
      properties:
        description:
          description: The description of the embedding model.
          title: description
          type: string
        embeddingModel:
          $ref: '#/components/schemas/EmbeddingModelNames'
          description: The name of the embedding model.
        languages:
          description: The list of languages the embedding models supports.
          items:
            $ref: '#/components/schemas/DatasetLanguages'
          title: languages
          type: array
        maxSequenceLength:
          description: The maximum input token sequence length that the embedding
            model can accept.
          title: maxSequenceLength
          type: integer
      required:
      - embeddingModel
      - description
      - maxSequenceLength
      - languages
      title: EmbeddingModel
      type: object
    EmbeddingModelNames:
      description: Embedding model names (matching the format of HuggingFace repositories).
      enum:
      - intfloat/e5-large-v2
      - intfloat/e5-base-v2
      - intfloat/multilingual-e5-base
      - intfloat/multilingual-e5-small
      - sentence-transformers/all-MiniLM-L6-v2
      - jinaai/jina-embedding-t-en-v1
      - jinaai/jina-embedding-s-en-v2
      - cl-nagoya/sup-simcse-ja-base
      title: EmbeddingModelNames
      type: string
    EmbeddingsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of Image Embeddings
          items:
            $ref: '#/components/schemas/ImageInsightsMetadataElement'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
          type: array
        targetValues:
          description: List of target values for classification or null
          items:
            description: Target value
            type: string
          type: array
      required:
      - embeddings
      - targetBins
      - targetValues
      type: object
    EmitterDataModel:
      description: Schema for emitter data.
      properties:
        id:
          anyOf:
          - type: string
          - type: 'null'
          description: Emitter identifier (ObjectId format).
          title: Id
        type:
          description: 'Emitter type. One of: ''user'', ''agent''.'
          enum:
          - user
          - agent
          title: Type
          type: string
      required:
      - type
      title: EmitterDataModel
      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:
      description: Attribute mapping between DataRobot and IdP.
      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
        organization:
          description: Organization.
          type: string
          x-versionadded: v2.37
        role:
          description: Role.
          type: string
        username:
          description: Username.
          type: string
      type: object
    EnhancedSamlClientConfig:
      description: Encryption related parameters.
      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'
          maxItems: 100
          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
    EnhancedSamlOrganizationMapping:
      properties:
        datarobotOrganizationId:
          description: DataRobot organization ID.
          type: string
        idpOrganizationId:
          description: Name of the identity provider organization.
          type: string
      required:
      - datarobotOrganizationId
      - idpOrganizationId
      type: object
      x-versionadded: v2.37
    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'
        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'
        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'
          maxItems: 100
          type: array
        id:
          description: SSO configuration ID.
          type: string
        idpMetadata:
          $ref: '#/components/schemas/SamlMetadataFile'
        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
          - 'null'
        name:
          description: The name of the SSO configuration.
          type: string
        organizationId:
          description: The organization ID to which the SSO config belongs.
          type: string
        organizationMapping:
          description: The list of DataRobot organization to identity provider organization
            maps.
          items:
            $ref: '#/components/schemas/SamlOrganizationMappingResponse'
          maxItems: 100
          type: array
          x-versionadded: v2.37
        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'
          maxItems: 100
          type: array
        securityParameters:
          $ref: '#/components/schemas/SamlSecurityParameters'
        sessionLengthSeconds:
          default: 604800
          description: Time window for the authentication session via IDP
          exclusiveMinimum: 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
    Entitlement:
      properties:
        name:
          description: Name of the entitlement to evaluate
          type: string
      required:
      - name
      type: object
      x-versionadded: v2.35
    EntitlementEvaluateResult:
      properties:
        name:
          description: Name of the entitlement to evaluate
          type: string
        value:
          description: The result of an entitlement evaluation.
          oneOf:
          - type: boolean
      required:
      - name
      - value
      type: object
      x-versionadded: v2.35
    EntitlementSetLease:
      properties:
        createdAt:
          description: Lease creation timestamp
          type: string
        createdBy:
          description: Created by user
          type: string
        entitlementSetId:
          description: UUID of the entitlement set
          type: string
        id:
          description: UUID of the lease
          type: string
        lastLeaseEndDate:
          description: Last lease end date timestamp
          type: string
        leaseCount:
          description: Lease count
          type: integer
        status:
          description: Status of the lease
          type: string
        tenantId:
          description: UUID of the tenant
          type: string
        updatedAt:
          description: Lease last update timestamp
          type: string
        updatedBy:
          description: Updated by user
          type: string
        validFrom:
          description: Lease valid from timestamp
          type: string
        validUntil:
          description: Lease valid until timestamp
          type: string
      required:
      - createdAt
      - entitlementSetId
      - id
      - status
      - tenantId
      - updatedAt
      type: object
      x-versionadded: v2.38
    EntitlementSetLeaseResponse:
      type: object
      x-versionadded: v2.38
    EntitlementSetLeasesRequest:
      properties:
        entitlementSetId:
          description: UUID of the entitlement set to filter leases by.
          type: string
        limit:
          default: 100
          description: Pagination limit (max 100).
          maximum: 100
          minimum: 1
          type: integer
        offset:
          default: 0
          description: Pagination offset.
          minimum: 0
          type: integer
        status:
          description: Status to filter leases by (e.g., ACTIVE, EXPIRED).
          type: string
        tenantId:
          description: UUID of the tenant to filter leases by.
          type: string
      type: object
      x-versionadded: v2.38
    EntitlementSetLeasesResponse:
      properties:
        count:
          description: Number of items in current page
          type: integer
        data:
          description: List of entitlement set leases
          items:
            $ref: '#/components/schemas/EntitlementSetLease'
          maxItems: 1000
          type: array
        next:
          description: URL for next page
          type: string
        previous:
          description: URL for previous page
          type: string
        totalCount:
          description: Total number of items
          type: integer
      required:
      - count
      - data
      - totalCount
      type: object
      x-versionadded: v2.38
    EntityCountByTypeResponse:
      description: Number of different type entities that use the dataset.
      properties:
        numCalendars:
          description: The number of calendars that use the dataset
          type: integer
        numExperimentContainer:
          description: The number of experiment containers that use the dataset.
          type: integer
          x-versionadded: v2.37
        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
      - numExperimentContainer
      - numExternalModelPackages
      - numFeatureDiscoveryConfigs
      - numPredictionDatasets
      - numProjects
      - numSparkSqlQueries
      type: object
    EntityInfo:
      description: Entity metadata derived from service name.
      properties:
        name:
          description: The display name of the entity.
          type: string
        serviceName:
          description: The service name associated with the entity.
          type: string
      required:
      - name
      - serviceName
      type: object
      x-versionadded: v2.45
    EntityLinkingSources:
      description: The source of the entity linking. Does not affect the operation
        of the API call. Only used for analytics.
      enum:
      - classic
      - nextGen
      - api
      title: EntityLinkingSources
      type: string
    EntityLinkingWorkflows:
      description: The workflow that is attaching this entity. Does not affect the
        operation of the API call. Only used for analytics.
      enum:
      - migration
      - creation
      - unspecified
      title: EntityLinkingWorkflows
      type: string
    EntityNotificationChannel:
      description: The notification channel information used to send the notification.
      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
          - 'null'
          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'
          maxItems: 100
          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
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        name:
          description: The name of the new notification channel.
          type: string
          x-versionadded: v2.33
        orgId:
          description: The ID of the organization that the notification channel belongs
            to.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        relatedEntityType:
          description: Type of related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the channel.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        validateSsl:
          description: Whether to validate SSL for the notification channel.
          type:
          - boolean
          - 'null'
          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'
          maxItems: 100
          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
          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 the related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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
          type:
          - string
          - 'null'
          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'
          maxItems: 100
          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
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        lastNotificationAt:
          description: The timestamp of the last notification sent to the channel.
          format: date-time
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        policyCount:
          description: The count of policies assigned to the channel.
          type: integer
          x-versionadded: v2.33
        relatedEntityId:
          description: The ID of the related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the channel.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type:
          - boolean
          - 'null'
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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 policy templates returned.
          type: integer
          x-versionadded: v2.33
        data:
          description: The entity notification policy templates.
          items:
            $ref: '#/components/schemas/EntityNotificationPolicyTemplateResponse'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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: Whether 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
          - 'null'
          x-versionadded: v2.33
        eventGroup:
          description: The group of the event that triggers the notification.
          enum:
          - secure_config.all
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - file.created
          - file.registered
          - file.deleted
          - file.shared
          - comment.created
          - comment.updated
          - invite_job.completed
          - 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.humility_rule
          - 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_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.custom_model_deployment_secure_config_failure
          - 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_activation_failed
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.custom_model_deployment_deactivation_failed
          - 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.prediction_payload_parsing_failure
          - 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
          - model_deployments.deployment_inference_server_idle_stopped
          - model_deployments.deployment_inference_server_maintenance_started
          - 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
          - use_case.shared
          - 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
          - custom_job_run.success
          - custom_job_run.failed
          - custom_job_run.interrupted
          - custom_job_run.cancelled
          - 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
          - abstract
          - moderation.metric.creation_error
          - moderation.metric.reporting_error
          - moderation.model.moderation_started
          - moderation.model.moderation_completed
          - moderation.model.pre_score_phase_started
          - moderation.model.pre_score_phase_completed
          - moderation.model.post_score_phase_started
          - moderation.model.post_score_phase_completed
          - moderation.model.config_error
          - moderation.model.runtime_error
          - moderation.model.scoring_started
          - moderation.model.scoring_completed
          - moderation.model.scoring_error
          - scim.user_provision_failed
          - scim.group_provision_failed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          type:
          - string
          - 'null'
          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: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
          x-versionadded: v2.33
      required:
      - channelId
      - channelScope
      - name
      - relatedEntityId
      - relatedEntityType
      type: object
    EntityNotificationPolicyCreateFromTemplate:
      properties:
        active:
          description: Whether 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: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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'
          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
          - 'null'
          x-versionadded: v2.33
        created:
          description: The date when the policy was created.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        eventGroup:
          $ref: '#/components/schemas/EventGroup'
          x-versionadded: v2.33
        eventType:
          $ref: '#/components/schemas/EventType'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        relatedEntityId:
          description: The id of related entity.
          type: string
          x-versionadded: v2.33
        relatedEntityType:
          description: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
          x-versionadded: v2.33
        templateId:
          description: The id of template.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          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: Whether 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 triggers the notification.
          enum:
          - secure_config.all
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - file.created
          - file.registered
          - file.deleted
          - file.shared
          - comment.created
          - comment.updated
          - invite_job.completed
          - 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.humility_rule
          - 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_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.custom_model_deployment_secure_config_failure
          - 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_activation_failed
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.custom_model_deployment_deactivation_failed
          - 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.prediction_payload_parsing_failure
          - 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
          - model_deployments.deployment_inference_server_idle_stopped
          - model_deployments.deployment_inference_server_maintenance_started
          - 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
          - use_case.shared
          - 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
          - custom_job_run.success
          - custom_job_run.failed
          - custom_job_run.interrupted
          - custom_job_run.cancelled
          - 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
          - abstract
          - moderation.metric.creation_error
          - moderation.metric.reporting_error
          - moderation.model.moderation_started
          - moderation.model.moderation_completed
          - moderation.model.pre_score_phase_started
          - moderation.model.pre_score_phase_completed
          - moderation.model.post_score_phase_started
          - moderation.model.post_score_phase_completed
          - moderation.model.config_error
          - moderation.model.runtime_error
          - moderation.model.scoring_started
          - moderation.model.scoring_completed
          - moderation.model.scoring_error
          - scim.user_provision_failed
          - scim.group_provision_failed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          type:
          - string
          - 'null'
          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: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/CreatedByResponse'
          x-versionadded: v2.33
        eventGroup:
          $ref: '#/components/schemas/EventGroup'
          x-versionadded: v2.33
        eventType:
          $ref: '#/components/schemas/EventType'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        relatedEntityType:
          description: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          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: Whether 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 triggers the notification.
          enum:
          - secure_config.all
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - file.created
          - file.registered
          - file.deleted
          - file.shared
          - comment.created
          - comment.updated
          - invite_job.completed
          - 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.humility_rule
          - 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_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.custom_model_deployment_secure_config_failure
          - 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_activation_failed
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.custom_model_deployment_deactivation_failed
          - 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.prediction_payload_parsing_failure
          - 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
          - model_deployments.deployment_inference_server_idle_stopped
          - model_deployments.deployment_inference_server_maintenance_started
          - 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
          - use_case.shared
          - 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
          - custom_job_run.success
          - custom_job_run.failed
          - custom_job_run.interrupted
          - custom_job_run.cancelled
          - 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
          - abstract
          - moderation.metric.creation_error
          - moderation.metric.reporting_error
          - moderation.model.moderation_started
          - moderation.model.moderation_completed
          - moderation.model.pre_score_phase_started
          - moderation.model.pre_score_phase_completed
          - moderation.model.post_score_phase_started
          - moderation.model.post_score_phase_completed
          - moderation.model.config_error
          - moderation.model.runtime_error
          - moderation.model.scoring_started
          - moderation.model.scoring_completed
          - moderation.model.scoring_error
          - scim.user_provision_failed
          - scim.group_provision_failed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          type:
          - string
          - 'null'
          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: Whether 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 triggers the notification.
          enum:
          - secure_config.all
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - file.created
          - file.registered
          - file.deleted
          - file.shared
          - comment.created
          - comment.updated
          - invite_job.completed
          - 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.humility_rule
          - 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_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.custom_model_deployment_secure_config_failure
          - 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_activation_failed
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.custom_model_deployment_deactivation_failed
          - 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.prediction_payload_parsing_failure
          - 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
          - model_deployments.deployment_inference_server_idle_stopped
          - model_deployments.deployment_inference_server_maintenance_started
          - 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
          - use_case.shared
          - 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
          - custom_job_run.success
          - custom_job_run.failed
          - custom_job_run.interrupted
          - custom_job_run.cancelled
          - 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
          - abstract
          - moderation.metric.creation_error
          - moderation.metric.reporting_error
          - moderation.model.moderation_started
          - moderation.model.moderation_completed
          - moderation.model.pre_score_phase_started
          - moderation.model.pre_score_phase_completed
          - moderation.model.post_score_phase_started
          - moderation.model.post_score_phase_completed
          - moderation.model.config_error
          - moderation.model.runtime_error
          - moderation.model.scoring_started
          - moderation.model.scoring_completed
          - moderation.model.scoring_error
          - scim.user_provision_failed
          - scim.group_provision_failed
          type: string
          x-versionadded: v2.33
        maximalFrequency:
          description: Maximal frequency between policy runs in ISO 8601 duration
            string.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        name:
          description: The name of the notification policy.
          maxLength: 100
          type: string
          x-versionadded: v2.33
      type: object
    EntityTagCreate:
      properties:
        entityType:
          description: The type of entity provided.
          enum:
          - experiment_container
          type: string
        name:
          description: The name of the Tag.
          maxLength: 100
          type: string
      required:
      - entityType
      - name
      type: object
      x-versionadded: v2.36
    EntityTagListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of entity tags that match the query.
          items:
            $ref: '#/components/schemas/EntityTagResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    EntityTagResponse:
      properties:
        entityType:
          description: The type of entity provided.
          enum:
          - experiment_container
          type: string
        id:
          description: The ID of the entity tag.
          type: string
        name:
          description: The name of the entity tag.
          type: string
      required:
      - entityType
      - id
      - name
      type: object
      x-versionadded: v2.36
    EntityTagUpdate:
      properties:
        name:
          description: The name of the entity tag.
          maxLength: 100
          type:
          - string
          - 'null'
      type: object
      x-versionadded: v2.36
    EnvironmentPublic:
      description: The public representation of an execution environment.
      properties:
        image:
          allOf:
          - $ref: '#/components/schemas/ImagePublic'
          description: The image of the environment.
          title: Image
        machine:
          allOf:
          - $ref: '#/components/schemas/Machine'
          description: The machine of the environment.
          title: Machine
        timeToLive:
          description: The inactivity timeout of the environment.
          title: Timetolive
          type: integer
      required:
      - image
      - machine
      title: EnvironmentPublic
      type: object
    EnvironmentSupplementalMetadata:
      description: Supplemental metadata for an environment.
      properties:
        id:
          description: The ID of the environment.
          title: Id
          type: string
        label:
          description: The label of the environment.
          title: Label
          type: string
        name:
          description: The name of the environment.
          title: Name
          type: string
      required:
      - id
      - name
      - label
      title: EnvironmentSupplementalMetadata
      type: object
    EnvironmentVariableResourceType:
      description: An enumeration.
      enum:
      - notebook
      title: EnvironmentVariableResourceType
      type: string
    EnvironmentVariableSchema:
      description: Environment variable schema.
      properties:
        assignedResourceId:
          description: The resource ID to which the environment variable is assigned.
          title: Assignedresourceid
          type: string
        assignedResourceType:
          allOf:
          - $ref: '#/components/schemas/EnvironmentVariableResourceType'
          default: notebook
          description: The resource type to which the environment variable is assigned.
        createdAt:
          description: The date and time when the environment variable was created.
          format: date-time
          title: Createdat
          type: string
        createdBy:
          description: The ID of the user who created the environment variable.
          title: Createdby
          type: string
        description:
          description: The description of the environment variable.
          maxLength: 500
          title: Description
          type: string
        id:
          description: The environment variable ID.
          title: Id
          type: string
        name:
          description: The name of the environment variable.
          maxLength: 253
          title: Name
          type: string
        updatedAt:
          description: The date and time when the environment variable was last updated.
          format: date-time
          title: Updatedat
          type: string
        updatedBy:
          description: The ID of the user who last updated the environment variable.
          title: Updatedby
          type: string
        value:
          description: The value of the environment variable.
          maxLength: 131072
          title: Value
          type: string
      required:
      - name
      - value
      - id
      - assignedResourceId
      - createdBy
      - createdAt
      title: EnvironmentVariableSchema
      type: object
    EnvironmentVariablesResponseSchema:
      description: List environment variables response schema.
      properties:
        data:
          description: List of environment variables
          items:
            $ref: '#/components/schemas/EnvironmentVariableSchema'
          title: Data
          type: array
      title: EnvironmentVariablesResponseSchema
      type: object
    EphemeralSessionEntityType:
      description: Types of entities that can be associated with an ephemeral session.
      enum:
      - CUSTOM_APP
      - CUSTOM_JOB
      - CUSTOM_MODEL
      - CUSTOM_METRIC
      - CODE_SNIPPET
      title: EphemeralSessionEntityType
      type: string
    EphemeralSessionKey:
      description: Key for an ephemeral session.
      properties:
        entityId:
          description: The ID of the entity.
          title: Entityid
          type: string
        entityType:
          allOf:
          - $ref: '#/components/schemas/EphemeralSessionEntityType'
          description: The type of the entity.
      required:
      - entityType
      - entityId
      title: EphemeralSessionKey
      type: object
    ErrorOutputSchema:
      description: The schema for the error output in a notebook cell.
      properties:
        ename:
          description: Error name.
          title: Ename
          type: string
        evalue:
          description: Error value.
          title: Evalue
          type: string
        outputType:
          const: error
          default: error
          description: Type of the output.
          title: Outputtype
          type: string
        traceback:
          description: Traceback of the error.
          items:
            type: string
          title: Traceback
          type: array
      required:
      - ename
      - evalue
      title: ErrorOutputSchema
      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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        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
    EvaluateEntitlementsRequest:
      properties:
        entitlements:
          description: Entitlements to evaluate
          items:
            $ref: '#/components/schemas/Entitlement'
          maxItems: 100
          type: array
      required:
      - entitlements
      type: object
      x-versionadded: v2.35
    EvaluateEntitlementsResponse:
      properties:
        entitlements:
          description: Results of evaluation
          items:
            $ref: '#/components/schemas/EntitlementEvaluateResult'
          maxItems: 100
          type: array
      required:
      - entitlements
      type: object
      x-versionadded: v2.35
    EvaluationDatasetConfigurationResponse:
      description: API response object for a single evaluation dataset configuration.
      properties:
        agentGoalsColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing expected agent goals
            (For agentic workflows).
          title: agentGoalsColumnName
        correctnessEnabled:
          anyOf:
          - type: boolean
          - type: 'null'
          deprecated: true
          description: Whether correctness is enabled for the evaluation dataset configuration.
          title: correctnessEnabled
        creationDate:
          description: The creation date of the evaluation dataset configuration (ISO
            8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the evaluation dataset configuration.
          title: creationUserId
          type: string
        datasetId:
          description: The ID of the evaluation dataset.
          title: datasetId
          type: string
        datasetName:
          description: The name of the evaluation dataset.
          title: datasetName
          type: string
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the evaluation dataset configuration.
          title: errorMessage
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the evaluation dataset.
        id:
          description: The ID of the evaluation dataset configuration.
          title: id
          type: string
        name:
          description: The name of the evaluation dataset configuration.
          title: name
          type: string
        playgroundId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the playground associated with the evaluation dataset
            configuration.
          title: playgroundId
        promptColumnName:
          description: The name of the dataset column containing the prompt text.
          title: promptColumnName
          type: string
        responseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing the response text.
          title: responseColumnName
        rowsCount:
          description: The rows count of the evaluation dataset.
          title: rowsCount
          type: integer
        size:
          description: The size of the evaluation dataset (in bytes).
          title: size
          type: integer
        tenantId:
          description: The ID of the DataRobot tenant this evaluation dataset configuration
            belongs to.
          format: uuid4
          title: tenantId
          type: string
        toolCallsColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing expected tool calls
            (For agentic workflows).
          title: toolCallsColumnName
        useCaseId:
          description: The ID of the use case associated with the evaluation dataset
            configuration.
          title: useCaseId
          type: string
        userName:
          description: The name of the user that created the evaluation dataset configuration.
          title: userName
          type: string
      required:
      - id
      - name
      - size
      - rowsCount
      - useCaseId
      - playgroundId
      - datasetId
      - datasetName
      - promptColumnName
      - responseColumnName
      - toolCallsColumnName
      - agentGoalsColumnName
      - userName
      - correctnessEnabled
      - creationUserId
      - creationDate
      - tenantId
      - executionStatus
      title: EvaluationDatasetConfigurationResponse
      type: object
    EvaluationDatasetMetricAggregationAggregatedByLLMBlueprintResponse:
      description: 'API response object for multiple evaluation dataset metric aggregation

        aggregated by llm blueprint.'
      properties:
        aggregatedItemCount:
          description: Number of items aggregated.
          title: aggregatedItemCount
          type: integer
        aggregatedItemDetails:
          description: List of details for aggregated items.
          items:
            $ref: '#/components/schemas/EvaluationDatasetMetricAggregationChatDetails'
          title: aggregatedItemDetails
          type: array
        aggregationType:
          $ref: '#/components/schemas/AggregationType'
          description: The type of metric aggregation.
        aggregationValue:
          anyOf:
          - type: number
          - items:
              $ref: '#/components/schemas/AggregationValue'
            type: array
          - items:
              $ref: '#/components/schemas/AggregatedAggregationValue'
            type: array
          - type: 'null'
          description: The aggregated value of the metric.
          title: aggregationValue
        customModelGuardId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model's guard the metric aggregation belongs
            to.
          title: customModelGuardId
        datasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The dataset ID of the evaluation dataset configuration.
          title: datasetId
        datasetName:
          anyOf:
          - type: string
          - type: 'null'
          description: The Data Registry dataset name of the evaluation dataset configuration.
          title: datasetName
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset configuration associated with
            the metric aggregation.
          title: evaluationDatasetConfigurationId
        llmBlueprintId:
          description: The ID of the LLM blueprint associated with the metric aggregation.
          title: llmBlueprintId
          type: string
        metricName:
          description: The name of the metric associated with the metric aggregation.
          title: metricName
          type: string
        ootbDatasetName:
          anyOf:
          - $ref: '#/components/schemas/OOTBDatasetName'
          - type: 'null'
          description: The name of the out-of-the-box dataset.
        tenantId:
          description: The ID of the tenant the metric aggregation belongs to.
          format: uuid4
          title: tenantId
          type: string
      required:
      - llmBlueprintId
      - evaluationDatasetConfigurationId
      - ootbDatasetName
      - datasetId
      - datasetName
      - metricName
      - aggregationValue
      - aggregationType
      - tenantId
      - customModelGuardId
      - aggregatedItemDetails
      - aggregatedItemCount
      title: EvaluationDatasetMetricAggregationAggregatedByLLMBlueprintResponse
      type: object
    EvaluationDatasetMetricAggregationChatDetails:
      description: Details for aggregated items.
      properties:
        chatId:
          description: The ID of the chat associated with the metric aggregation.
          title: chatId
          type: string
        chatLink:
          description: The link to the chat associated with the metric aggregation.
          title: chatLink
          type: string
        chatName:
          description: The name of the chat associated with the metric aggregation.
          title: chatName
          type: string
        creationDate:
          description: The creation date of the metric aggregation (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the metric aggregation.
          title: creationUserId
          type: string
        creationUserName:
          description: The name of the user that created the metric aggregation.
          title: creationUserName
          type: string
      required:
      - chatId
      - chatName
      - chatLink
      - creationDate
      - creationUserId
      - creationUserName
      title: EvaluationDatasetMetricAggregationChatDetails
      type: object
    EvaluationDatasetMetricAggregationFieldQueryParam:
      description: Field used for aggregation when listing evaluation dataset metric
        aggregations.
      enum:
      - metricName
      - llmBlueprintId
      - aggregationType
      - evaluationDatasetConfigurationId
      title: EvaluationDatasetMetricAggregationFieldQueryParam
      type: string
    EvaluationDatasetMetricAggregationResponse:
      description: API response object for a single evaluation dataset metric aggregation.
      properties:
        aggregationType:
          $ref: '#/components/schemas/AggregationType'
          description: The type of metric aggregation.
        aggregationValue:
          anyOf:
          - type: number
          - items:
              $ref: '#/components/schemas/AggregationValue'
            type: array
          - items:
              $ref: '#/components/schemas/AggregatedAggregationValue'
            type: array
          - type: 'null'
          description: The aggregated value of the metric.
          title: aggregationValue
        chatId:
          description: The ID of the chat associated with the metric aggregation.
          title: chatId
          type: string
        chatLink:
          description: The link to the chat associated with the metric aggregation.
          title: chatLink
          type: string
        chatName:
          description: The name of the chat associated with the metric aggregation.
          title: chatName
          type: string
        creationDate:
          description: The creation date of the metric aggregation (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the metric aggregation.
          title: creationUserId
          type: string
        creationUserName:
          description: The name of the user that created the metric aggregation.
          title: creationUserName
          type: string
        customModelGuardId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model's guard the metric aggregation belongs
            to.
          title: customModelGuardId
        datasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The dataset ID of the evaluation dataset configuration.
          title: datasetId
        datasetName:
          anyOf:
          - type: string
          - type: 'null'
          description: The Data Registry dataset name of the evaluation dataset configuration.
          title: datasetName
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset configuration associated with
            the metric aggregation.
          title: evaluationDatasetConfigurationId
        llmBlueprintId:
          description: The ID of the LLM blueprint associated with the metric aggregation.
          title: llmBlueprintId
          type: string
        metricName:
          description: The name of the metric associated with the metric aggregation.
          title: metricName
          type: string
        ootbDatasetName:
          anyOf:
          - $ref: '#/components/schemas/OOTBDatasetName'
          - type: 'null'
          description: The name of the out-of-the-box dataset.
        tenantId:
          description: The ID of the tenant the metric aggregation belongs to.
          format: uuid4
          title: tenantId
          type: string
      required:
      - chatId
      - chatName
      - chatLink
      - creationDate
      - creationUserId
      - creationUserName
      - llmBlueprintId
      - evaluationDatasetConfigurationId
      - ootbDatasetName
      - datasetId
      - datasetName
      - metricName
      - aggregationValue
      - aggregationType
      - tenantId
      - customModelGuardId
      title: EvaluationDatasetMetricAggregationResponse
      type: object
    EvaluationDatasetMetricAggregationUniqueFieldValuesResponse:
      description: API response object for a single unique computed metric.
      properties:
        uniqueFieldValue:
          description: The unique value associated with the metric aggregation.
          title: uniqueFieldValue
          type: string
      required:
      - uniqueFieldValue
      title: EvaluationDatasetMetricAggregationUniqueFieldValuesResponse
      type: object
    Event:
      description: The event object.
      properties:
        attributes:
          additionalProperties:
            type: string
          description: The attributes of the event.
          type: object
        name:
          description: The name of the event.
          type: string
      required:
      - attributes
      - name
      type: object
      x-versionadded: v2.37
    EventBody:
      additionalProperties: true
      description: Body for all event types. Content field is mandatory, any additional
        fields are allowed.
      properties:
        content:
          description: Event body content text.
          maxLength: 100000
          minLength: 1
          title: Content
          type: string
      required:
      - content
      title: EventBody
      type: object
    EventCountTrigger:
      additionalProperties: false
      description: 'Trigger based on event count.


        Fires when the session''s event count reaches or exceeds the configured threshold.'
      properties:
        eventCount:
          description: Event count threshold
          exclusiveMinimum: 0.0
          maximum: 1000000.0
          title: Eventcount
          type: integer
      required:
      - eventCount
      title: EventCountTrigger
      type: object
    EventGroup:
      description: The group of the event that triggers the notification.
      properties:
        events:
          description: The events included in this group.
          items:
            $ref: '#/components/schemas/EventType'
          maxItems: 1000
          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: The event types belonging to the group.
          items:
            type: string
          type: array
        id:
          description: The group ID.
          type: string
        label:
          description: The 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:
      description: Schema for event response.
      properties:
        body:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Event body content.
          title: Body
        createdAt:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Event creation timestamp.
          title: Createdat
        emitterId:
          anyOf:
          - type: string
          - type: 'null'
          description: Emitter identifier.
          title: Emitterid
        emitterType:
          anyOf:
          - type: string
          - type: 'null'
          description: Emitter type.
          title: Emittertype
        eventType:
          anyOf:
          - type: string
          - type: 'null'
          description: Event type.
          title: Eventtype
        id:
          description: The event type as an ID.
          type: string
        label:
          description: The event type for display.
          type: string
        requireMaxFrequency:
          description: Indicates if an event requires max frequency setting.
          type: boolean
        sequenceId:
          anyOf:
          - type: integer
          - type: 'null'
          description: Event sequence number within the session.
          title: Sequenceid
      required:
      - id
      - label
      - requireMaxFrequency
      title: EventResponse
      type: object
    EventType:
      description: The type of the event that triggers the notification.
      enum:
      - message
      - tool_output
      - status
      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
      title: EventType
      type: object
    ExecuteCellsRequest:
      description: Request payload values for executing notebook cells.
      properties:
        cellIds:
          description: List of cell IDs to execute.
          items:
            type: string
          title: Cellids
          type: array
        cells:
          description: List of cells to execute.
          items:
            $ref: '#/components/schemas/NotebookCellExecData'
          title: Cells
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      - generation
      - cells
      title: ExecuteCellsRequest
      type: object
    ExecuteCodeRequest:
      properties:
        code:
          description: The code to execute.
          title: Code
          type: string
      required:
      - code
      title: ExecuteCodeRequest
      type: object
    ExecuteFileResponse:
      description: Response schema for executing a file.
      properties:
        kernelId:
          description: ID of the kernel assigned to the file.
          title: Kernelid
          type: string
      required:
      - kernelId
      title: ExecuteFileResponse
      type: object
    ExecuteResultOutputSchema:
      description: The schema for the execute result output in a notebook cell.
      properties:
        data:
          additionalProperties:
            anyOf:
            - type: string
            - items:
                type: string
              type: array
            - {}
          description: Data of the output.
          title: Data
          type: object
        executionCount:
          default: 0
          description: Execution count of the output.
          title: Executioncount
          type: integer
        metadata:
          description: Metadata of the output.
          title: Metadata
          type: object
        outputType:
          const: execute_result
          default: execute_result
          description: Type of the output.
          title: Outputtype
          type: string
      title: ExecuteResultOutputSchema
      type: object
    ExecutingFileData:
      description: Schema for executing file information.
      properties:
        filePath:
          description: Path to the file being executed.
          title: Filepath
          type: string
        kernelId:
          description: ID of the kernel assigned to the file.
          title: Kernelid
          type: string
      required:
      - kernelId
      - filePath
      title: ExecutingFileData
      type: object
    ExecutingFilesResponse:
      description: Response schema for listing executing files.
      properties:
        executingFiles:
          description: List of executing files with their kernel IDs.
          items:
            $ref: '#/components/schemas/ExecutingFileData'
          title: Executingfiles
          type: array
      required:
      - executingFiles
      title: ExecutingFilesResponse
      type: object
    ExecutionEnvironmentAssignRequest:
      description: Request schema for assigning an execution environment to a notebook.
      properties:
        environmentId:
          description: The execution environment ID.
          title: Environmentid
          type: string
        environmentSlug:
          description: The execution environment slug.
          title: Environmentslug
          type: string
        language:
          description: The programming language of the environment.
          title: Language
          type: string
        languageVersion:
          description: The programming language version.
          title: Languageversion
          type: string
        machineId:
          description: The machine ID.
          title: Machineid
          type: string
        machineSlug:
          description: The machine slug.
          title: Machineslug
          type: string
        timeToLive:
          description: Inactivity timeout limit.
          maximum: 525600.0
          minimum: 3.0
          title: Timetolive
          type: integer
        versionId:
          description: The execution environment version ID.
          title: Versionid
          type: string
      title: ExecutionEnvironmentAssignRequest
      type: object
    ExecutionEnvironmentCreate:
      properties:
        description:
          default: ''
          description: The description of the environment to be created.
          maxLength: 10000
          type: string
        environmentId:
          description: The ID the new environment should use. Only admins can create
            environments with pre-defined IDs
          type: string
        isPublic:
          description: True/False public access for the environment. Public environments
            can be used by all users without sharing. Public access to environments
            can only be added by an admin
          type: boolean
        name:
          description: The name of the environment to be created.
          maxLength: 255
          type: string
        programmingLanguage:
          default: other
          description: The programming language of the environment to be created.
          enum:
          - python
          - r
          - java
          - julia
          - legacy
          - other
          type: string
        useCases:
          description: The list of use cases supported by the environment
          items:
            enum:
            - customModel
            - notebook
            - gpu
            - customApplication
            - sparkApplication
            - customJob
            type: string
          maxItems: 6
          type: array
          x-versionadded: v2.36
      required:
      - name
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentCreateResponse:
      properties:
        id:
          description: The ID of the newly created environment.
          type: string
      required:
      - id
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of execution environments.
          items:
            $ref: '#/components/schemas/ExecutionEnvironmentResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentPermadelete:
      properties:
        executionEnvironmentIds:
          description: List of custom environments to be permanently deleted.
          items:
            description: An ID for a custom environment to be permanently deleted.
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - executionEnvironmentIds
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentResponse:
      properties:
        created:
          description: 'ISO-8601 environment creation timestamp. Example: 2016-12-13T11:12:13.141516Z.'
          type: string
        deploymentsCount:
          description: Number of deployments in environment.
          type: integer
        description:
          description: The description of the environment.
          type: string
        id:
          description: The ID of the environment.
          type: string
        isPublic:
          description: If the environment is public.
          type: boolean
          x-versionadded: v2.23
        latestSuccessfulVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionResponse'
          x-versionadded: v2.36
        latestVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionResponse'
        name:
          description: The name of the environment.
          type: string
        programmingLanguage:
          description: The programming language of the environment to be created.
          enum:
          - python
          - r
          - java
          - julia
          - legacy
          - other
          type: string
        useCases:
          description: The list of use cases supported by the environment
          items:
            enum:
            - customModel
            - notebook
            - gpu
            - customApplication
            - sparkApplication
            - customJob
            type: string
          maxItems: 6
          type: array
          x-versionadded: v2.36
        username:
          description: The username of the user.
          type: string
      required:
      - created
      - description
      - id
      - isPublic
      - latestSuccessfulVersion
      - latestVersion
      - name
      - programmingLanguage
      - username
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentSchema:
      properties:
        created:
          description: The time the environment was created.
          format: date-time
          title: Created
          type: string
        description:
          description: Execution environment description.
          title: Description
          type: string
        gpuOptimized:
          default: false
          description: Whether the environment is GPU optimized.
          title: Gpuoptimized
          type: boolean
        id:
          description: Execution environment ID.
          title: Id
          type: string
        isBuiltIn:
          default: false
          description: Whether the environment is a built-in environment supplied
            by DataRobot.
          title: Isbuiltin
          type: boolean
        isDownloadable:
          description: Whether the environment is downloadable.
          title: Isdownloadable
          type: boolean
        isPublic:
          description: Whether the environment is public.
          title: Ispublic
          type: boolean
        latestSuccessfulVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionSchema'
        latestVersion:
          $ref: '#/components/schemas/ExecutionEnvironmentVersionSchema'
        name:
          description: Execution environment name.
          title: Name
          type: string
        programmingLanguage:
          description: Programming language of the environment.
          title: Programminglanguage
          type: string
        requiredMetadataKeys:
          description: Required metadata keys.
          items:
            $ref: '#/components/schemas/RequiredMetadataKey'
          title: Requiredmetadatakeys
          type: array
        useCases:
          description: List of use cases for the environment. This includes 'notebooks',
            at a minimum .
          items:
            type: string
          title: Usecases
          type: array
        username:
          description: The username of the user who created the environment.
          title: Username
          type: string
      required:
      - id
      - isDownloadable
      - isPublic
      - name
      - programmingLanguage
      - created
      - latestVersion
      - latestSuccessfulVersion
      - username
      title: ExecutionEnvironmentSchema
      type: object
    ExecutionEnvironmentShortResponse:
      description: Execution environment associated with this deployment.
      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
    ExecutionEnvironmentUpdate:
      properties:
        description:
          description: The new description of the environment.
          maxLength: 10000
          type: string
        isPublic:
          description: If the environment is public.
          type: boolean
          x-versionadded: v2.39
        name:
          description: New execution environment name.
          maxLength: 255
          type: string
        programmingLanguage:
          description: The new programming language of the environment.
          enum:
          - python
          - r
          - java
          - julia
          - legacy
          - other
          type: string
        useCases:
          description: The list of use cases supported by the environment
          items:
            enum:
            - customModel
            - notebook
            - gpu
            - customApplication
            - sparkApplication
            - customJob
            type: string
          maxItems: 6
          type: array
          x-versionadded: v2.36
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentUsageByNotebooks:
      description: Notebook using a specific execution environment.
      properties:
        createdAt:
          description: The time the notebook was created.
          format: date-time
          title: Createdat
          type: string
        createdBy:
          description: The username of the user who created the notebook.
          title: Createdby
          type: string
        environmentVersion:
          description: The version of the environment used by the notebook.
          title: Environmentversion
          type: string
        notebookId:
          description: Notebook ID.
          title: Notebookid
          type: string
        notebookLastSession:
          description: The last time the notebook was started.
          format: date-time
          title: Notebooklastsession
          type: string
        notebookName:
          description: Notebook name.
          title: Notebookname
          type: string
        useCaseId:
          description: The use case ID of the notebook.
          title: Usecaseid
          type: string
      required:
      - notebookId
      - notebookName
      - createdAt
      - environmentVersion
      title: ExecutionEnvironmentUsageByNotebooks
      type: object
    ExecutionEnvironmentUsageByNotebooksQuery:
      description: Query parameters for listing notebooks using a specific execution
        environment.
      properties:
        limit:
          default: 10
          description: The limit or results to return.
          exclusiveMinimum: 0.0
          maximum: 100.0
          title: Limit
          type: integer
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
      title: ExecutionEnvironmentUsageByNotebooksQuery
      type: object
    ExecutionEnvironmentUsageByNotebooksResponse:
      description: Response schema for listing notebooks using a specific execution
        environment.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of notebooks using the environment.
          items:
            $ref: '#/components/schemas/ExecutionEnvironmentUsageByNotebooks'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: ExecutionEnvironmentUsageByNotebooksResponse
      type: object
    ExecutionEnvironmentVersionBuildLogResponse:
      properties:
        error:
          description: The message specifying why the build failed. Empty if the build
            finished successfully.
          type: string
        log:
          description: The full console output of the execution environment build.
            Logs are empty unless version build is finished.
          type: string
      required:
      - error
      - log
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentVersionCreate:
      properties:
        contextUrl:
          default: ''
          description: Docker context URL of the environment version. It is not intended
            to be used for automatic processing.
          maxLength: 1000
          type: string
          x-versionadded: v2.37
        description:
          default: ''
          description: The description of the environment version.
          maxLength: 10000
          type: string
        dockerContext:
          description: Context tar.gz or zip file. The Docker Context file should
            be a tar.gz or zip file containing at minimum a single top-level file
            named "Dockerfile".  This file should be a Docker-compatible Dockerfile
            using syntax as defined in the `official Docker documentation <https://docs.docker.com/engine/reference/builder/>`_.
            The archive may contain additional files as well. These files may be added
            into the final container using `ADD <https://docs.docker.com/engine/reference/builder/#add>`_
            and/or `COPY <https://docs.docker.com/engine/reference/builder/#copy>`_
            directives in the Dockerfile.
          format: binary
          type: string
        dockerImage:
          description: The pre-built Docker image saved as a .tar archive. If not
            supplied, the environment will be built from the supplied dockerContext.
          format: binary
          type: string
        dockerImageUri:
          description: The URI of the Docker image that is used to build the environment
            version. Parameter dockerContext may also be provided to upload context,
            but the image URI is used for the build.
          type: string
          x-versionadded: v2.37
        environmentVersionId:
          description: The ID the new environment version should use. Only admins
            can create environment versions with pre-defined IDs
          type: string
        label:
          default: ''
          description: Human readable version indicator.
          maxLength: 50
          type: string
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentVersionListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of execution environment versions.
          items:
            $ref: '#/components/schemas/ExecutionEnvironmentVersionResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentVersionResponse:
      description: Latest version build for this environment.
      properties:
        buildId:
          description: The environment version image build ID.
          type:
          - string
          - 'null'
        buildStatus:
          description: The status of the build.
          enum:
          - submitted
          - processing
          - failed
          - success
          - aborted
          type: string
        contextUrl:
          description: Docker context URL of the environment version. It is not intended
            to be used for automatic processing.
          type: string
          x-versionadded: v2.37
        created:
          description: 'ISO-8601 environment version creation timestamp. Example:
            2016-12-13T11:12:13.141516Z.'
          type: string
        description:
          description: The description of the environment version.
          type: string
        dockerContext:
          description: A URL that can be used to download the Docker context of the
            environment version, if available or `null`
          type:
          - string
          - 'null'
        dockerContextSize:
          description: The size of the uploaded Docker context in bytes if available,
            or `null` if not.
          type:
          - integer
          - 'null'
        dockerImage:
          description: A URL that can be used to download the built Docker image as
            a tarball of the environment version, if available or `null`
          type:
          - string
          - 'null'
        dockerImageSize:
          description: The size of the built Docker image in bytes if available, or
            `null` if not.
          type:
          - integer
          - 'null'
        environmentId:
          description: The ID of the environment.
          type: string
        id:
          description: The ID of the environment version.
          type: string
        imageId:
          description: The Docker image ID of the environment version.
          type: string
        label:
          description: Human readable version indicator.
          type: string
        sourceDockerImageUri:
          description: The image URI that was used as a base to build the environment.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
      required:
      - buildStatus
      - contextUrl
      - created
      - description
      - dockerContext
      - dockerContextSize
      - dockerImage
      - dockerImageSize
      - environmentId
      - id
      - imageId
      - label
      type: object
      x-versionadded: v2.36
    ExecutionEnvironmentVersionSchema:
      description: Execution environment version schema.
      properties:
        buildStatus:
          description: 'Build status of the environment version. Possible values:
            ''success'', ''failed''.'
          title: Buildstatus
          type: string
        created:
          description: The time the environment version was created.
          format: date-time
          title: Created
          type: string
        description:
          description: Description of the environment version.
          title: Description
          type: string
        dockerContext:
          description: URL for downloading the Docker context of the environment version.
          title: Dockercontext
          type: string
        dockerContextSize:
          description: Size of the Docker context in bytes.
          title: Dockercontextsize
          type: integer
        dockerImage:
          description: URL for downloading the Docker image of the environment version.
          title: Dockerimage
          type: string
        dockerImageSize:
          description: Size of the Docker image in bytes.
          title: Dockerimagesize
          type: integer
        environmentId:
          description: Execution environment ID.
          title: Environmentid
          type: string
        id:
          description: Execution environment version ID.
          title: Id
          type: string
        imageId:
          description: Image ID of the environment version.
          title: Imageid
          type: string
        label:
          description: Label of the environment version.
          title: Label
          type: string
        libraries:
          description: List of libraries in the environment version.
          items:
            type: string
          title: Libraries
          type: array
        sourceDockerImageUri:
          description: The URI that the image environment version is based on. Basing
            off of the image URI is different from docker context or uploaded image-based
            environment versions.
          title: Sourcedockerimageuri
          type: string
      required:
      - id
      - environmentId
      - buildStatus
      - created
      title: ExecutionEnvironmentVersionSchema
      type: object
    ExecutionEnvironmentVersionShortResponse:
      description: Execution environment version associated with this deployment.
      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
    ExecutionEnvironmentVersionsResponse:
      description: Response schema for listing execution environment versions.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of environment versions.
          items:
            $ref: '#/components/schemas/ExecutionEnvironmentVersionSchema'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: ExecutionEnvironmentVersionsResponse
      type: object
    ExecutionEnvironmentsResponse:
      description: Response schema for listing execution environments.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of execution environments.
          items:
            $ref: '#/components/schemas/ExecutionEnvironmentSchema'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: ExecutionEnvironmentsResponse
      type: object
    ExecutionStatus:
      description: Job and entity execution status.
      enum:
      - NEW
      - RUNNING
      - COMPLETED
      - REQUIRES_USER_INPUT
      - SKIPPED
      - ERROR
      title: ExecutionStatus
      type: string
    ExecutionStatusSchema:
      description: Schema for the execution status of a notebook session.
      properties:
        cellId:
          description: The ID of the cell currently being executed.
          title: Cellid
          type: string
        executed:
          allOf:
          - $ref: '#/components/schemas/NotebookActionSignature'
          description: Info related to when the execution was completed.
          title: Executed
        inputRequest:
          allOf:
          - $ref: '#/components/schemas/AwaitingInputState'
          description: The input request state of the cell.
          title: Inputrequest
        notebookId:
          description: The ID of the notebook.
          title: Notebookid
          type: string
        queuedCellIds:
          description: The IDs of the cells that are queued for execution.
          items:
            type: string
          title: Queuedcellids
          type: array
        status:
          allOf:
          - $ref: '#/components/schemas/KernelExecutionStatus'
          description: The status of the kernel execution. Possible values are 'busy'
            or 'idle'.
        submitted:
          allOf:
          - $ref: '#/components/schemas/NotebookActionSignature'
          description: Info related to when the execution request was submitted.
          title: Submitted
      required:
      - status
      - notebookId
      title: ExecutionStatusSchema
      type: object
    ExperimentContainerFilterMetadataMetricsObjectResponse:
      description: Model performance evaluation metrics (shorthand abbreviations)
      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
            - F1 Score
            - Weighted F1 Score
            - Precision
            - Weighted Precision
            - Recall
            - Weighted Recall
            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'
        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: 0
            maximum: 100
            type: number
          maxItems: 7
          type: array
      required:
      - metrics
      - modelFamilies
      - samplePcts
      type: object
    ExperimentContainerLastActivity:
      description: The last activity details.
      properties:
        timestamp:
          description: The 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
          type:
          - string
          - 'null'
        blenderInputModelNumbers:
          description: List of model ID numbers used in the blender.
          items:
            description: Model ID numbers used in the blender.
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        blueprintNumber:
          description: The blueprint number associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        createdAt:
          description: Timestamp generated at model's project creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        datasetName:
          description: The name of the dataset used to build the model in the associated
            project.
          type: string
        featurelistName:
          description: The name of the feature list associated with the model.
          type: string
          x-versionadded: v2.36
        frozenPct:
          description: The percentage used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: A boolean setting whether the model can be converted to scorable
            Java code.
          type: boolean
        hasHoldout:
          description: Whether the model has holdout.
          type: boolean
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        isBlender:
          description: Indicates if the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: Indicates if the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        isDatetimePartitioned:
          description: Indicates whether the model is a datetime-partitioned model.
          type: boolean
        isExternalPredictionModel:
          description: Indicates if the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        isFrozen:
          description: Indicates if the model is a frozen model.
          type: boolean
          x-versionadded: v2.36
        isMaseBaselineModel:
          description: Indicates if the model is a baseline model with MASE score
            '1.000'.
          type: boolean
          x-versionadded: v2.36
        isReferenceModel:
          description: Indicates if the model is a reference model.
          type: boolean
          x-versionadded: v2.36
        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: Indicates whether the model has been starred for easier identification.
          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
        isTrainedOnGpu:
          description: Indicates if the model was trained using GPU workers.
          type: boolean
          x-versionadded: v2.36
        isTransparent:
          description: Indicates if the model is a transparent model with exposed
            coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: Indicates if the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        isUsingCrossValidation:
          default: true
          description: Indicates whether cross-validation is the partitioning strategy
            used for the project associated with the model.
          type: boolean
          x-versionadded: v2.36
        metric:
          description: Model performance information by the specified filtered evaluation
            metric
          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
        modelNumber:
          description: The model number from the single experiment leaderboard.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        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: 0
          maximum: 100
          type:
          - number
          - 'null'
        supportsMonotonicConstraints:
          description: Indicates if the model supports enforcing monotonic constraints.
          type: boolean
          x-versionadded: v2.36
        supportsNewSeries:
          description: Indicates if the model supports new series (time series only).
          type: boolean
          x-versionadded: v2.36
        targetName:
          description: Name of modeling target
          type: string
        targetType:
          description: The type of modeling target
          enum:
          - Binary
          - Regression
          type: string
        trainingRowCount:
          default: 1
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type: integer
          x-versionadded: v2.36
      required:
      - autopilotDataSelectionMethod
      - blueprintNumber
      - createdAt
      - createdBy
      - datasetName
      - hasCodegen
      - hasHoldout
      - icons
      - isBlender
      - isCustom
      - isDatetimePartitioned
      - isExternalPredictionModel
      - isFrozen
      - isMaseBaselineModel
      - isReferenceModel
      - isScoringAvailableForModelsTrainedIntoValidationHoldout
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - isUsingCrossValidation
      - metric
      - modelFamily
      - modelId
      - name
      - projectId
      - projectName
      - samplePct
      - supportsMonotonicConstraints
      - supportsNewSeries
      - targetName
      - targetType
      - trainingRowCount
      type: object
    ExperimentContainerReferenceDatasetMetadata:
      properties:
        dataSourceType:
          description: The type of the data source used to create the dataset if relevant.
          type:
          - string
          - 'null'
        datasetSize:
          description: Size of the dataset in bytes
          type:
          - integer
          - 'null'
          x-versionadded: v2.34
        datasetSourceType:
          description: The source type of the dataset.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
      required:
      - dataSourceType
      - datasetSize
      - datasetSourceType
      - isSnapshot
      - isWranglingEligible
      - latestRecipeId
      type: object
    ExperimentContainerReferenceDatasetResponse:
      description: Metadata about the reference of the dataset in the Use Case.
      properties:
        createdAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        lastActivity:
          $ref: '#/components/schemas/ExperimentContainerLastActivity'
      required:
      - createdAt
      - lastActivity
      type: object
    ExperimentContainerReferenceFileMetadata:
      properties:
        dataSourceType:
          description: The data source type used to create the file if relevant.
          type:
          - string
          - 'null'
        fileSourceType:
          description: The source type of the file.
          type:
          - string
          - 'null'
        numFiles:
          description: The number of files in the file.
          type:
          - integer
          - 'null'
      required:
      - dataSourceType
      - fileSourceType
      - numFiles
      type: object
      x-versionadded: v2.37
    ExperimentContainerReferencePlaygroundMetadata:
      properties:
        description:
          description: Description of the playground
          type: string
        playgroundType:
          description: The type of the playground
          type: string
          x-versionadded: v2.37
      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
        stage:
          description: Stage of the experiment.
          type: string
          x-versionadded: v2.34
        statusErrorMessage:
          description: Experiment failure explanation.
          type: string
      required:
      - isDraft
      - isErrored
      - isWorkbenchEligible
      - stage
      - 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
          - sqlRecipe
          - SqlRecipe
          - SQL_RECIPE
          - wranglingRecipe
          - WranglingRecipe
          - WRANGLING_RECIPE
          - featureDiscoveryRecipe
          - FeatureDiscoveryRecipe
          - FEATURE_DISCOVERY_RECIPE
          type:
          - string
          - 'null'
      required:
      - dataType
      type: object
    ExperimentContainerReferenceRetrieve:
      properties:
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        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'
        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'
          - $ref: '#/components/schemas/ExperimentContainerReferenceVectorDatabasesMetadata'
          - $ref: '#/components/schemas/ExperimentContainerReferenceFileMetadata'
        name:
          description: The name of the experiment container reference.
          type: string
        processingState:
          description: The current ingestion process state of the dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        updatedAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        updatedBy:
          description: The ID of the user who last updated.
          type:
          - string
          - 'null'
        useCaseId:
          description: The ID linking the Use Case with the entity type.
          type: string
        userHasAccess:
          description: Identifies if a user has access to the entity.
          type: boolean
          x-versionadded: v2.36
        versions:
          description: A list of entity versions.
          items:
            $ref: '#/components/schemas/UseCaseEntityVersion'
          maxItems: 100
          type: array
          x-versionadded: v2.36
      required:
      - entityId
      - entityType
      - id
      - name
      - updatedAt
      - useCaseId
      type: object
    ExperimentContainerReferenceVectorDatabasesMetadata:
      properties:
        errorMessage:
          description: The error message, if any, for the vector database.
          type:
          - string
          - 'null'
          x-versionadded: v2.38
        source:
          description: The source of the vector database
          type: string
      required:
      - errorMessage
      - source
      type: object
      x-versionadded: v2.37
    ExperimentContainerUserResponse:
      description: A user associated with a use case.
      properties:
        email:
          description: The email address of the user.
          type:
          - string
          - 'null'
        fullName:
          description: The full name of the user.
          type:
          - string
          - 'null'
        id:
          description: The ID of the user.
          type: string
        userhash:
          description: The user's gravatar hash.
          type:
          - string
          - 'null'
        username:
          description: The username of the user.
          type:
          - string
          - 'null'
      required:
      - email
      - id
      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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        batchIds:
          description: IDs of batches to export. Null for real-time data exports.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.33
        end:
          description: End of the period of prediction data to collect. Defaults to
            now, or a week after the start time.
          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. Defaults
            to a week before the end time.
          format: date-time
          type: string
          x-versionadded: v2.33
      type: object
    ExportEntity:
      properties:
        associationIds:
          description: Association IDs of rows to export
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
          x-versionadded: v2.35
        augmentationType:
          default: NO_AUGMENTATION
          description: Indicates if prediction data is augmented with actuals or metrics
          enum:
          - NO_AUGMENTATION
          - ACTUALS_AND_METRICS
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        batches:
          description: Metadata associated with exported batch.
          items:
            $ref: '#/components/schemas/PredictionDataBatch'
          maxItems: 100
          minItems: 1
          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'
          type: array
          x-versionadded: v2.33
        error:
          $ref: '#/components/schemas/ExportError'
          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'
          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:
      description: Error description. Appears when prediction data export job failed
        (status is FAILED).
      properties:
        message:
          description: A human readable error message describing failure cause.
          type: string
          x-versionadded: v2.33
      required:
      - message
      type: object
    ExportItem:
      properties:
        amount:
          description: The cost for the usage.
          type: number
          x-versionadded: v2.42
        cloud:
          description: The cloud provider where the workload was executed.
          type: string
          x-versionadded: v2.41
        cloudRegion:
          description: The cloud region where the workload was executed.
          type: string
          x-versionadded: v2.41
        cost:
          description: The numeric price for the workload.
          type: number
          x-versionadded: v2.41
        costUnit:
          description: The unit of price calculation.
          type: string
          x-versionadded: v2.42
        currency:
          default: USD
          description: The price currency.
          enum:
          - usd
          - Usd
          - USD
          - jpy
          - Jpy
          - JPY
          type: string
          x-versionadded: v2.41
        resourceBundleId:
          description: The identifier of the resource bundle
          type: string
        resourceBundleName:
          description: Human readable name of the resource bundle
          type: string
        usageUnit:
          description: The unit of measurement for the usage value
          type: string
        usageValue:
          description: Numeric measure of the usage
          type: number
        userDisplayName:
          description: The display name of the user
          type: string
        userId:
          description: The identifier of the user
          type: string
        workloadId:
          description: The identifier of the workload
          type: string
        workloadName:
          description: Human readable name of the workload
          type: string
      required:
      - resourceBundleName
      - usageUnit
      - usageValue
      - userDisplayName
      - userId
      - workloadId
      - workloadName
      type: object
      x-versionadded: v2.35
    ExportNotebookQuerySchema:
      description: Query parameters for exporting a notebook.
      properties:
        includeOutput:
          default: true
          description: Whether to include the cell output of the notebook in the export.
          title: Includeoutput
          type: boolean
      title: ExportNotebookQuerySchema
      type: object
    ExportResponse:
      properties:
        data:
          description: The usage records.
          items:
            $ref: '#/components/schemas/ExportItem'
          maxItems: 10000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.35
    ExposePortSchema:
      description: Port creation schema for a notebook.
      properties:
        description:
          description: Description of the exposed port.
          maxLength: 500
          title: Description
          type: string
        port:
          description: Exposed port number.
          title: Port
          type: integer
      required:
      - port
      title: ExposePortSchema
      type: object
    ExposedPortListSchema:
      description: List of exposed ports for a notebook.
      properties:
        data:
          description: List of exposed ports.
          items:
            $ref: '#/components/schemas/ExposedPortSchema'
          title: Data
          type: array
      title: ExposedPortListSchema
      type: object
    ExposedPortSchema:
      description: Exposed port schema for a notebook.
      properties:
        description:
          description: Description of the exposed port.
          title: Description
          type: string
        id:
          description: Exposed port ID.
          title: Id
          type: string
        notebookId:
          description: Notebook ID the exposed port belongs to.
          title: Notebookid
          type: string
        port:
          description: Exposed port number.
          title: Port
          type: integer
        url:
          description: URL to access the exposed port.
          title: Url
          type: string
      required:
      - id
      - notebookId
      - port
      - url
      title: ExposedPortSchema
      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
          type:
          - string
          - 'null'
        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: 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: The list of feature derivation window definitions that will
            be used.
          items:
            $ref: '#/components/schemas/FeatureDerivationWindow'
          maxItems: 3
          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: 0
          maximum: 30
          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:
          description: Summary of the relationship quality information
          oneOf:
          - $ref: '#/components/schemas/RelationshipQualitySummaryNewFormat'
          - $ref: '#/components/schemas/RelationshipQualitySummary'
      required:
      - dataset1Keys
      - dataset2Identifier
      - dataset2Keys
      type: object
    ExtendedRelationshipsConfigRetrieve:
      properties:
        datasetDefinitions:
          description: The 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
          type:
          - string
          - 'null'
        featureDiscoverySettings:
          description: The list of feature discovery settings used to customize the
            feature discovery process.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySettingResponse'
          type: array
        id:
          description: ID of relationships configuration.
          type: string
        relationships:
          description: The 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?
          type:
          - boolean
          - 'null'
      required:
      - datasetDefinitions
      - relationships
      type: object
    ExternalNaNPredictionsEventData:
      description: The external NaN predictions event payload.
      properties:
        count:
          description: The number of NaN predictions by the external model.
          exclusiveMinimum: 0
          type: integer
        modelId:
          default: null
          description: The identifier of the model.
          type:
          - string
          - 'null'
      required:
      - count
      - modelId
      type: object
    ExternalOAuthProviderCredentialsFields:
      properties:
        authenticationId:
          description: The authentication ID for an external OAuth provider. Used
            to retrieve tokens from DataRobot OAuth service.
          type: string
        credentialType:
          description: The type of these credentials, 'external_oauth_provider' here.
          enum:
          - external_oauth_provider
          type: string
      required:
      - authenticationId
      - credentialType
      type: object
      x-versionadded: v2.46
    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; it 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 dataset ID the data comes from.
          type: string
        modelId:
          description: The model ID for the scores.
          type: string
        projectId:
          description: The project ID 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 that was used to compute the score.
          type: string
        value:
          description: The score value.
          type: number
      required:
      - label
      - value
      type: object
    ExternalScoresListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of objects containing the following data.
          items:
            $ref: '#/components/schemas/ExternalScoresListData'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    ExternalTSBaselineMetadata:
      description: The id of the catalog item that is being used as the external baseline
        data
      properties:
        datasetId:
          description: Catalog version id for external prediction data that can be
            used as a baseline to calculate new metrics.
          type:
          - string
          - 'null'
        datasetName:
          description: The name of the timeseries baseline dataset for the project
          type:
          - string
          - 'null'
      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 passed the validation
            check or not.
          type: boolean
        message:
          description: A message providing more detail on the validation result.
          type:
          - string
          - 'null'
        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
    ExtraMetricSettings:
      description: Extra settings for the metric that do not reference other entities.
      properties:
        toolCallAccuracy:
          anyOf:
          - $ref: '#/components/schemas/ToolCallAccuracySettings'
          - type: 'null'
          description: Extra settings for the tool call accuracy metric.
      title: ExtraMetricSettings
      type: object
    FailedInviteData:
      description: Details about why the invite failed.
      properties:
        email:
          description: The email address of the invited user.
          type: string
        errorMessage:
          description: The error message explaining why the invite failed.
          type: string
        userId:
          description: The ID of the user.
          type: string
      required:
      - email
      - errorMessage
      - userId
      type: object
      x-versionadded: v2.39
    FairnessHealth:
      description: Fairness health status setting. Only available if deployment supports
        fairness.
      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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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:
      description: Summary of per feature fairness.
      properties:
        metricName:
          description: Name of the metric.
          enum:
          - proportionalParity
          - equalParity
          - favorableClassBalance
          - unfavorableClassBalance
          - trueUnfavorableRateParity
          - trueFavorableRateParity
          - favorablePredictiveValueParity
          - unfavorablePredictiveValueParity
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
        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'
      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: 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.
          type:
          - string
          - 'null'
        featureType:
          description: Feature type.
          type:
          - string
          - 'null'
        importance:
          description: Numeric measure of the relationship strength between the feature
            and target (independent of model or other features).
          type:
          - number
          - 'null'
        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.
          type:
          - integer
          - 'null'
        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`.
          type:
          - number
          - 'null'
      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:
      description: Number of occurrences of each class being compared.
      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: 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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalLogLines:
          description: The total number of lines in the 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.
          type:
          - number
          - 'null'
        featureImpact:
          description: The feature impact score for this feature.
          type:
          - number
          - 'null'
        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'
          x-versionadded: v2.33
        driftScore:
          description: Drift score of the feature.
          type:
          - number
          - 'null'
          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
    FeatureDriftOverSpaceBucket:
      properties:
        baselineSampleSize:
          description: The baseline sample size for the hexagon.
          type: integer
        driftScore:
          description: The drift score for this feature.
          type: number
        hexagon:
          description: h3 hexagon.
          type: string
        sampleSize:
          description: The sample size for the hexagon.
          type: integer
      required:
      - baselineSampleSize
      - driftScore
      - hexagon
      - sampleSize
      type: object
      x-versionadded: v2.35
    FeatureDriftOverSpaceResponse:
      properties:
        data:
          description: An array [DriftObject], each in the form described below
          items:
            $ref: '#/components/schemas/FeatureDriftOverSpaceBucket'
          maxItems: 10000
          type: array
        featureName:
          description: The name of the feature to retrieve drift scores for. Defaults
            to the target or, if there is no target, the most important feature.
          type: string
        geoFeatureName:
          description: The name of the geospatial feature. Segmented analysis must
            be enabled for the feature specified.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
      required:
      - data
      - featureName
      - geoFeatureName
      type: object
      x-versionadded: v2.35
    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.
          type:
          - number
          - 'null'
        featureImpact:
          description: The feature impact score of the feature.
          type: number
        featureName:
          description: Name of the feature.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
        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)
          type:
          - string
          - 'null'
        period:
          $ref: '#/components/schemas/TimeRange'
        previous:
          description: A URL pointing to the previous page (if null, there is no previous
            page)
          type:
          - string
          - 'null'
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
        segmentValue:
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
      required:
      - data
      - modelId
      type: object
    FeatureDriftSetting:
      description: The feature drift setting for the deployment.
      properties:
        enabled:
          description: Indicates whether feature drift tracking is enabled for this
            deployment.
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.21
      type: object
    FeatureEffects:
      properties:
        featureImpactScore:
          description: The feature impact score.
          type: number
        featureName:
          description: The name of the feature.
          type: string
        featureType:
          description: The 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.
          type:
          - boolean
          - 'null'
        partialDependence:
          $ref: '#/components/schemas/PartialDependence'
        predictedVsActual:
          $ref: '#/components/schemas/PredictedVsActual'
        weightLabel:
          description: The weight label if a weight was configured for the project.
          type:
          - string
          - 'null'
      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
          type:
          - integer
          - 'null'
          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: The 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: The model's data source.
          type: string
      required:
      - backtestIndex
      - featureEffects
      - modelId
      - projectId
      - source
      type: object
    FeatureEffectsInsightResponse:
      description: Feature effects data.
      properties:
        featureEffects:
          description: The Feature Effects computational results for each feature.
          items:
            $ref: '#/components/schemas/FeatureEffects'
          type: array
      required:
      - featureEffects
      type: object
    FeatureEffectsResponse:
      properties:
        featureEffects:
          description: The 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: The model's 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.
          type:
          - number
          - 'null'
      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:
      description: Feature impact data.
      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.
          type:
          - integer
          - 'null'
      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.
          type:
          - string
          - 'null'
        redundantWith:
          description: Name of feature that has the highest correlation with this
            feature.
          type:
          - string
          - 'null'
      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: The URL for the next page of results, or null if there is no
            next page.
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL for the previous page of results, or null if there
            is no previous page.
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - integer
          - 'null'
          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:
      description: Statistics of the key.
      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:
      description: Statistics of the key.
      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'
      required:
      - key
      - summary
      type: object
    FeatureKeySummaryResponseValidatorSummarizedCategorical:
      description: For a Summarized Categorical columns, this will contain statistics
        for the top 50 keys (truncated to 103 characters)
      properties:
        key:
          description: Name of the key.
          type: string
        summary:
          $ref: '#/components/schemas/FeatureKeySummaryDetailsResponseValidatorSummarizedCategorical'
      required:
      - key
      - summary
      type: object
    FeatureLineageJoin:
      description: '**join** step details.'
      properties:
        joinType:
          description: Kind of SQL JOIN applied.
          enum:
          - left, right
          type: string
        leftTable:
          $ref: '#/components/schemas/FeatureLineageJoinTable'
        rightTable:
          $ref: '#/components/schemas/FeatureLineageJoinTable'
      required:
      - joinType
      - leftTable
      - rightTable
      type: object
    FeatureLineageJoinTable:
      description: Information about a dataset which was considered left in a join.
      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'
        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'
      required:
      - id
      - parents
      - stepType
      type: object
    FeatureLineageTimeInfo:
      description: Description of a feature derivation window which was applied to
        this **action** step.
      properties:
        duration:
          $ref: '#/components/schemas/TimeDelta'
        latest:
          $ref: '#/components/schemas/TimeDelta'
      required:
      - duration
      - latest
      type: object
    FeatureListCreate:
      properties:
        description:
          description: The description of the featurelist.
          type: string
        features:
          description: The 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: The name of the featurelist to be created.
          type: string
      required:
      - features
      - name
      type: object
    FeatureListModify:
      properties:
        description:
          description: The new description of the featurelist.
          type:
          - string
          - 'null'
        name:
          description: The new name of the featurelist.
          type: string
      type: object
    FeatureListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: An array of features.
          items:
            $ref: '#/components/schemas/Feature'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.35
      required:
      - data
      - next
      - previous
      - totalCount
      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: Whether this metric is valid for binary classification.
          type: boolean
        supportsMulticlass:
          description: Whether this metric is valid for multiclass classification.
          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:
          - type:
            - string
            - 'null'
          - type:
            - boolean
            - 'null'
          - type:
            - number
            - 'null'
          - type:
            - integer
            - 'null'
          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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
          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: The project ID the featurelist belongs to.
          type: string
      required:
      - created
      - features
      - id
      - isUserCreated
      - name
      - numModels
      - projectId
      type: object
    FeaturesChunkDefinitionResponse:
      description: Feature chunk definition properties.
      type: object
      x-versionadded: v2.37
    FeedbackMetadata:
      description: Prompt feedback metadata.
      properties:
        feedback:
          anyOf:
          - $ref: '#/components/schemas/FeedbackSentiment'
          - type: 'null'
          description: The sentiment of the feedback.
      required:
      - feedback
      title: FeedbackMetadata
      type: object
    FeedbackResult:
      description: Prompt feedback included in the result metadata.
      properties:
        negativeUserIds:
          default: []
          description: The list of user IDs whose feedback is negative.
          items:
            type: string
          title: negativeUserIds
          type: array
        positiveUserIds:
          default: []
          description: The list of user IDs whose feedback is positive.
          items:
            type: string
          title: positiveUserIds
          type: array
      title: FeedbackResult
      type: object
    FeedbackSentiment:
      description: The sentiment of the feedback.
      enum:
      - '1'
      - '0'
      title: FeedbackSentiment
      type: string
    FilePermadelete:
      properties:
        catalogIds:
          description: The catalog IDs to be deleted.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - catalogIds
      type: object
      x-versionadded: v2.37
    FilePermadeleteDryRunResponse:
      properties:
        fileVersionsToDelete:
          description: The IDs of file versions to be deleted for each corresponding
            file.
          items:
            $ref: '#/components/schemas/FileToVersionMap'
          maxItems: 1000
          type: array
        filesToDelete:
          description: The IDs of files to be deleted.
          items:
            type: string
          maxItems: 1000
          type: array
        warnings:
          description: The warnings on potential issues that may occur with some or
            all of the file deletions.
          items:
            $ref: '#/components/schemas/FilePermadeleteWarnings'
          maxItems: 1000
          type: array
      required:
      - fileVersionsToDelete
      - filesToDelete
      type: object
      x-versionadded: v2.37
    FilePermadeleteResponse:
      properties:
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the permadelete job's status.
          type: string
      required:
      - statusId
      type: object
      x-versionadded: v2.37
    FilePermadeleteWarnings:
      properties:
        catalogIds:
          description: The IDs of the files associated with the warning.
          items:
            type: string
          maxItems: 1000
          type: array
        warning:
          description: The warning on potential issues if the listed files were deleted.
          type: string
      required:
      - catalogIds
      - warning
      type: object
      x-versionadded: v2.37
    FileResponse:
      properties:
        fileChecksum:
          description: The checksum of the file.
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        fileCreatedAt:
          description: The date when the file was created.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.43
        fileName:
          description: The name of the file. The actual file can be retrieved with
            :http:get:`/api/v2/files/(catalogId)/file/`.
          type: string
        fileSize:
          description: The size of the file, in bytes.
          type: integer
        fileType:
          description: The file type, if known.
          type: string
        ingestErrors:
          description: Any errors associated with the file.
          type:
          - string
          - 'null'
      required:
      - fileChecksum
      - fileCreatedAt
      - fileName
      - fileSize
      - fileType
      - ingestErrors
      type: object
      x-versionadded: v2.37
    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
    FileToVersionMap:
      properties:
        catalogId:
          description: The ID of a file to be deleted.
          type: string
        versionIds:
          description: The IDs of associated file versions to be deleted.
          items:
            type: string
          maxItems: 1000
          type: array
      required:
      - catalogId
      - versionIds
      type: object
      x-versionadded: v2.37
    FileUpload:
      properties:
        file:
          description: The file to upload.
          format: binary
          type: string
        originalCatalogId:
          default: null
          description: If the contents of the file being uploaded are derived from
            a file in a catalog entity which was used to clone, the current catalog
            entity, the original catalog entity ID in which the file exists.
          type:
          - string
          - 'null'
          x-versionadded: v2.38
        originalFileName:
          default: null
          description: If the contents of the file being uploaded are derived from
            a file in the catalog entity, the name of the file it is derived from.
          type:
          - string
          - 'null'
      required:
      - file
      type: object
      x-versionadded: v2.38
    FilesAsyncResponse:
      properties:
        catalogId:
          description: The catalog item ID.
          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
      - statusId
      type: object
      x-versionadded: v2.38
    FilesDuration:
      properties:
        duration:
          default: 60
          description: Access ttl in seconds (maximum value is 300s).
          exclusiveMinimum: 0
          maximum: 300
          type: integer
        fileName:
          description: The name of a file to download from an unstructured dataset.
            If not specified, it will download either the original archive file or,
            if there is only one file, it will download that.
          type: string
      type: object
      x-versionadded: v2.37
    FilesDurationAndFiles:
      properties:
        duration:
          default: 600
          description: Access ttl in seconds (maximum value is 3000s).
          exclusiveMinimum: 0
          maximum: 3000
          type: integer
        fileNames:
          description: The names of files to download from an unstructured dataset.
            If not specified, it will download either the original archive file or,
            if there is only one file, it will download that.
          items:
            type:
            - string
            - 'null'
          maxItems: 100
          type: array
      required:
      - fileNames
      type: object
      x-versionadded: v2.37
    FilesEmpty:
      type: object
      x-versionadded: v2.37
    FilesEntityCountByTypeResponse:
      description: Number of different type entities that use the file.
      properties:
        numExperimentContainer:
          description: The number of experiment containers that use the file.
          type: integer
      required:
      - numExperimentContainer
      type: object
      x-versionadded: v2.37
    FilesFromDataSource:
      properties:
        credentialData:
          description: The credentials to be used to authenticate with the database
            in place of the credential id.
          oneOf:
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/ExternalOAuthProviderCredentialsFields'
        credentialId:
          description: The identifier for the set of credentials to use to authenticate
            with the database.
          type: string
        dataSourceId:
          description: The identifier of the DataSource to use as the source of data.
          type: string
        useArchiveContents:
          default: 'True'
          description: If true, extract archive contents and associate them with the
            catalog entity.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - dataSourceId
      type: object
      x-versionadded: v2.37
    FilesFromFile:
      properties:
        file:
          description: The file to upload.
          format: binary
          type: string
        originalCatalogId:
          default: null
          description: If the contents of the file being uploaded are derived from
            a file in a catalog entity which was used to clone, the current catalog
            entity, the original catalog entity ID in which the file exists.
          type:
          - string
          - 'null'
          x-versionadded: v2.38
        originalFileName:
          default: null
          description: If the contents of the file being uploaded are derived from
            a file in the catalog entity, the name of the file it is derived from.
          type:
          - string
          - 'null'
          x-versionadded: v2.38
        useArchiveContents:
          default: 'True'
          description: If true, extract archive contents and associate with the catalog
            entity.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - file
      type: object
      x-versionadded: v2.37
    FilesFromUrl:
      properties:
        url:
          description: The URL to download the file used to create the catalog entity.
          format: url
          type: string
        useArchiveContents:
          default: 'True'
          description: If true, extract archive contents and associate them with the
            catalog entity.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - url
      type: object
      x-versionadded: v2.37
    FilesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of file metadata.
          items:
            $ref: '#/components/schemas/FileResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    FilesStageResponse:
      properties:
        catalogId:
          description: The ID of the catalog entry.
          type: string
        stageId:
          description: The ID of the stage.
          type: string
      required:
      - catalogId
      - stageId
      type: object
      x-versionadded: v2.38
    FilesVersionResponse:
      properties:
        catalogId:
          description: The ID of the catalog entry.
          type: string
        catalogVersionId:
          description: The ID of the catalog entry version.
          type: string
        numFiles:
          description: The number of files in the file entity.
          type: integer
      required:
      - catalogId
      - catalogVersionId
      - numFiles
      type: object
      x-versionadded: v2.38
    FilesystemObjectSchema:
      description: This schema is used for filesystem objects (files and directories)
        in the filesystem.
      properties:
        lastUpdatedAt:
          description: Last updated time of the filesystem object.
          format: date-time
          title: Lastupdatedat
          type: string
        mediaType:
          description: Media type of the filesystem object.
          title: Mediatype
          type: string
        name:
          description: Name of the filesystem object.
          title: Name
          type: string
        path:
          description: Path to the filesystem object.
          title: Path
          type: string
        sizeInBytes:
          description: Size of the filesystem object in bytes.
          title: Sizeinbytes
          type: integer
        type:
          allOf:
          - $ref: '#/components/schemas/FilesystemObjectType'
          description: Type of the filesystem object. Possible values include 'dir',
            'file'.
      required:
      - path
      - type
      - name
      title: FilesystemObjectSchema
      type: object
    FilesystemObjectType:
      description: Type of the filesystem object.
      enum:
      - dir
      - file
      title: FilesystemObjectType
      type: string
    FilesystemSortBy:
      description: An enumeration.
      enum:
      - name
      - -name
      - updated_at
      - -updated_at
      title: FilesystemSortBy
      type: string
    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:
      description: The transformation description.
      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
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - conditions
      - keepRows
      - operator
      - skip
      type: object
    FilterOptionsQuery:
      description: Query options for filtering notebooks in the notebooks directory.
      properties:
        allUseCases:
          default: false
          description: Whether to include all use cases.
          title: Allusecases
          type: boolean
        useCaseId:
          description: The ID of a usecase to filter by.
          title: Usecaseid
          type: string
      title: FilterOptionsQuery
      type: object
    FilterOptionsResponse:
      description: Response schema for filter options in the notebooks directory.
      properties:
        owners:
          description: A list of possible owners to filter notebooks by.
          items:
            $ref: '#/components/schemas/UserInfo'
          title: Owners
          type: array
        tags:
          description: A list of possible tags to filter notebooks by.
          items:
            type: string
          title: Tags
          type: array
      title: FilterOptionsResponse
      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
          type:
          - string
          - 'null'
          x-versionadded: v2.14
        allowPartialHistoryTimeSeriesPredictions:
          description: Specifies whether the time series predictions can use partial
            historical data.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
        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 partition
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.15
        calendarName:
          description: The name of the calendar used in this project.
          type:
          - string
          - 'null'
          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
          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
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
        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'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.9
        unsupervisedMode:
          description: A boolean value indicating whether an unsupervised project
            should be created.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.31
        unsupervisedType:
          description: The type of unsupervised project.
          enum:
          - anomaly
          - clustering
          type:
          - string
          - 'null'
          x-versionadded: v2.31
        useCrossSeriesFeatures:
          description: For multiseries projects only. Indicating whether to use cross-series
            features.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
        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
          - 'null'
          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:
      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).
      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:
      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).
      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
    FloatSettingConstraints:
      description: Available constraints for float settings.
      properties:
        maxValue:
          anyOf:
          - type: number
          - type: 'null'
          description: The maximum value of the setting (inclusive).
          title: maxValue
        minValue:
          anyOf:
          - type: number
          - type: 'null'
          description: The minimum value of the setting (inclusive).
          title: minValue
        type:
          const: float
          default: float
          description: The data type of the setting.
          title: type
          type: string
      title: FloatSettingConstraints
      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`.
          type:
          - number
          - 'null'
        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`.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        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
          type:
          - number
          - 'null'
        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.
          type:
          - integer
          - 'null'
        normalizedError:
          description: Normalized average absolute residual value of the bin. `null`
            if there are no entries in the bin.
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        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:
      description: Status for backtest/holdout training.
      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'
        holdoutStatuses:
          $ref: '#/components/schemas/ForecastVsActualPlotsStatus'
        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:
      description: Status for forecast vs actual plots.
      properties:
        training:
          $ref: '#/components/schemas/ForecastVsActualPlotsForecastDistancesStatus'
        validation:
          $ref: '#/components/schemas/ForecastVsActualPlotsForecastDistancesStatus'
      required:
      - training
      - validation
      type: object
    FormattedResponseDeployment:
      properties:
        createdAt:
          description: The created date time.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          x-versionadded: v2.35
        description:
          description: The deployment description.
          type: string
        id:
          description: Unique identifier of the deployment.
          type: string
        label:
          description: The deployment label.
          type: string
        lastActivity:
          description: The type of the last activity. Can be "Added" or "Modified".
          enum:
          - created
          - Created
          - CREATED
          - modified
          - Modified
          - MODIFIED
          type: string
          x-versionadded: v2.35
        type:
          description: The deployment type.
          type: string
        updatedAt:
          description: The last modified date time.
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          x-versionadded: v2.35
        userHasAccess:
          description: Indicates if a user has access to this deployment.
          type: boolean
          x-versionadded: v2.35
      required:
      - id
      type: object
      x-versionadded: v2.35
    FormattedSummary:
      description: Relationship quality assessment report associated with the relationship
      properties:
        enrichmentRate:
          $ref: '#/components/schemas/Warnings'
        mostRecentData:
          $ref: '#/components/schemas/Warnings'
        windowSettings:
          $ref: '#/components/schemas/Warnings'
      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.
          type:
          - number
          - 'null'
        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: The list of frequent values and data quality information.
          items:
            $ref: '#/components/schemas/FrequentValueData'
          type: array
        name:
          description: The name of the feature.
          type: string
        numRows:
          description: Number of rows in the sample used to determine frequent values
          type: integer
        projectId:
          description: The 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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentialsFields'
          - $ref: '#/components/schemas/GcpCredentialsFields'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentialsFields'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentialsFields'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentialsFields'
          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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentialsFields'
          - $ref: '#/components/schemas/GcpCredentialsFields'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentialsFields'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentialsFields'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentialsFields'
          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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - 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
            - SAMPLE
            - 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.
          type:
          - string
          - 'null'
        creationDate:
          description: The date when the dataset was created.
          format: date-time
          type: string
        dataEngineQueryId:
          description: The ID of the source data engine query.
          type:
          - string
          - 'null'
        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: The ID of the datasource used as the source of the dataset.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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'
        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
        featureDiscoveryProjectId:
          description: Feature Discovery project ID used to create the dataset.
          type: string
          x-versionadded: v2.35
        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: The ID of the source recipe.
          type:
          - string
          - 'null'
        rowCount:
          description: The number of rows in the dataset.
          type: integer
          x-versionadded: v2.21
        sampleSize:
          $ref: '#/components/schemas/SampleSize'
          x-versionadded: v2.27
        tags:
          description: List of tags attached to the item.
          items:
            type: string
          type: array
        timeSeriesProperties:
          $ref: '#/components/schemas/TimeSeriesProperties'
          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/dr-pr-tst-data/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
    FullFileDetailsResponse:
      properties:
        createdBy:
          description: Username of the user who created the file.
          type:
          - string
          - 'null'
        creationDate:
          description: The date when the file was created.
          format: date-time
          type: string
        dataSourceId:
          description: ID of the data source used as the source of the file.
          type:
          - string
          - 'null'
        dataSourceType:
          description: The type of the data source that was used as the source of
            the file.
          type: string
        description:
          description: The description of the file.
          type:
          - string
          - 'null'
        entityCountByType:
          $ref: '#/components/schemas/FilesEntityCountByTypeResponse'
          x-versionadded: v2.37
        error:
          description: Details of exception raised during ingestion process, if any.
          type: string
        fileId:
          description: The ID of this file.
          type: string
        isLatestVersion:
          description: Whether this file version is the latest version of this file.
          type: boolean
          x-versionadded: v2.37
        lastModificationDate:
          description: The ISO 8601 formatted date and time when the file was last
            modified.
          format: date-time
          type: string
        lastModifierFullName:
          description: Full name of user who was the last to modify the file.
          type: string
        name:
          description: The name of this file in the catalog.
          type: string
        numFiles:
          description: The number of files in the file entity.
          type: integer
        processingState:
          description: Current ingestion process state of file.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        tags:
          description: List of tags attached to the item.
          items:
            type: string
          maxItems: 100
          type: array
        uri:
          description: The URI to the data source.
          type: string
        versionId:
          description: The object ID of the catalog_version the file belongs to.
          type: string
      required:
      - createdBy
      - creationDate
      - dataSourceId
      - dataSourceType
      - description
      - entityCountByType
      - error
      - fileId
      - isLatestVersion
      - lastModificationDate
      - lastModifierFullName
      - name
      - numFiles
      - processingState
      - tags
      - uri
      - versionId
      type: object
      x-versionadded: v2.37
    GCPDataStreamer:
      description: Stream CSV data chunks from Google Storage
      properties:
        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
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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:
      description: Stream CSV data chunks from Google Storage
      properties:
        credentialId:
          description: Use the specified credential to access the url
          type:
          - string
          - 'null'
        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:
      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.
      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:
      description: Save CSV data chunks to Google Storage
      properties:
        credentialId:
          description: Use the specified credential to access the url
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks to Google Storage
      properties:
        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
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
    GcpCredentialsFields:
      properties:
        configId:
          description: The ID of secure configurations shared by admin. Alternative
            to googleConfigId (deprecated). If specified, cannot include gcpKey.
          type: string
          x-versionadded: v2.32
        credentialType:
          description: The type of these credentials, 'gcp' here.
          enum:
          - gcp
          type: string
        gcpKey:
          $ref: '#/components/schemas/GCPKey'
          x-versionadded: v2.21
        googleConfigId:
          description: The ID of secure configurations shared by admin. This is deprecated.
            Please use configId instead. If specified, cannot include gcpKey.
          type: string
          x-versionadded: v2.30
      required:
      - credentialType
      type: object
      x-versionadded: v2.46
    GenerateTransformationPlan:
      properties:
        baselinePeriods:
          default:
          - 1
          description: A list of periodicities used to calculate naive target features.
          items:
            exclusiveMinimum: 0
            type: integer
          maxItems: 10
          minItems: 1
          type: array
        datetimePartitionColumn:
          description: The column that is used to order the data.
          type: string
        doNotDeriveColumns:
          default: []
          description: Columns to exclude from derivation; for them only the first
            lag is suggested.
          items:
            type: string
          maxItems: 200
          type: array
        excludeLowInfoColumns:
          default: true
          description: Whether to ignore columns with low signal (only include features
            that pass a "reasonableness" check that determines whether they contain
            information useful for building a generalizable model).
          type: boolean
        featureDerivationWindows:
          description: A list of rolling windows of past values, defined in terms
            of rows, that are used to derive features for the modeling dataset.
          items:
            exclusiveMinimum: 0
            maximum: 300
            type: integer
          maxItems: 5
          minItems: 1
          type: array
        featureReductionThreshold:
          default: 0.9
          description: Threshold for feature reduction. For example, 0.9 means that
            features which cumulatively reach 90 % of importance are returned. Additionally,
            no more than 200 features are returned.
          exclusiveMinimum: 0
          maximum: 1
          type:
          - number
          - 'null'
        forecastDistances:
          description: A list of forecast distances, which defines the number of rows
            into the future to predict.
          items:
            exclusiveMinimum: 0
            type: integer
          maxItems: 20
          minItems: 1
          type: array
        knownInAdvanceColumns:
          default: []
          description: Columns that are known in advance (future values are known).
            Values for these known columns must be specified at prediction time.
          items:
            type: string
          maxItems: 200
          type: array
        maxLagOrder:
          description: The maximum lag order. This value cannot be greater than the
            largest feature derivation window.
          exclusiveMinimum: 0
          maximum: 100
          type:
          - integer
          - 'null'
        multiseriesIdColumn:
          description: The series ID column, if present. This column partitions data
            to create a multiseries modeling project.
          type:
          - string
          - 'null'
        numberOfOperationsToUse:
          description: If set, a transformation plan is suggested after the specified
            number of operations.
          type: integer
        targetColumn:
          description: The column intended to be used as the target for modeling.
            This parameter is required for generating naive features.
          type: string
      required:
      - datetimePartitionColumn
      - featureDerivationWindows
      - forecastDistances
      - targetColumn
      type: object
      x-versionadded: v2.35
    GeneratedDockerfile:
      additionalProperties: false
      description: System generates a Dockerfile from execution environment metadata.
      properties:
        entrypoint:
          description: Entrypoint baked into the generated Dockerfile CMD (e.g. ["python",
            "app.py"]).
          items:
            type: string
          minItems: 1
          title: Entrypoint
          type: array
        executionEnvironmentId:
          description: Execution environment ID used to resolve the base Docker image.
          title: Execution Environment ID
          type: string
        executionEnvironmentVersionId:
          description: Execution environment version ID that pins the exact base image
            tag.
          title: Execution Environment Version ID
          type: string
        source:
          const: generated
          default: generated
          title: Source
          type: string
      required:
      - executionEnvironmentId
      - executionEnvironmentVersionId
      - entrypoint
      title: GeneratedDockerfile
      type: object
    GeneratedMetadata:
      description: Custom model conversion output metadata.
      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
          maxItems: 50
          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:
      description: Data engine generator settings of the given `generator_type`.
      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: 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
      - target
      - 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
            - postgres
            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.
            type:
            - string
            - 'null'
          dialect:
            description: Source type data was retrieved from. Should be omitted for
              dataset rewrangling and feature discovery recipes.
            enum:
            - snowflake
            - bigquery
            - databricks
            - spark
            - postgres
            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'
            maxItems: 1
            minItems: 1
            type: array
          recipeType:
            default: WRANGLING
            description: Type of the recipe workflow.
            enum:
            - sql
            - Sql
            - SQL
            - wrangling
            - Wrangling
            - WRANGLING
            - featureDiscovery
            - FeatureDiscovery
            - FEATURE_DISCOVERY
            - featureDiscoveryPrivatePreview
            - FeatureDiscoveryPrivatePreview
            - FEATURE_DISCOVERY_PRIVATE_PREVIEW
            type: string
          snapshotPolicy:
            description: Snapshot policy to use the created recipe.
            enum:
            - fixed
            - latest
            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:
      description: Geo feature plot data
      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'
        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'
        properties:
          $ref: '#/components/schemas/GeoFeaturePlotFeatureProperties'
        type:
          description: With a fixed value of 'Feature'.
          type: string
      required:
      - geometry
      - properties
      - type
      type: object
    GeoFeaturePlotFeatureProperties:
      description: Properties of location features.
      properties:
        count:
          description: Total num of samples located within this geometry.
          type: integer
      required:
      - count
      type: object
    GeoFeaturePlotSummary:
      description: Summary of feature map.
      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:
      description: Geometry.
      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
    GeoPoint:
      description: Geo centroid.
      properties:
        latitude:
          description: Latitude.
          type: number
        longitude:
          description: Longitude.
          type: number
      required:
      - latitude
      - longitude
      type: object
      x-versionadded: v2.36
    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'
        projectId:
          description: The project to select a location feature from.
          type: string
      required:
      - feature
      - plotData
      - projectId
      type: object
    GeospatialCoordinateField:
      description: A custom metric geospatial coordinate source when reading values
        from columnar dataset like a file.
      properties:
        columnName:
          description: Column name
          type:
          - string
          - 'null'
      required:
      - columnName
      type: object
      x-versionadded: v2.36
    GeospatialFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          type:
          - number
          - 'null'
        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
    GetCellsQuery:
      description: Base query schema for getting notebook cells.
      properties:
        cellIds:
          description: List of cell IDs to get.
          items:
            type: string
          title: Cellids
          type: array
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      - cellIds
      title: GetCellsQuery
      type: object
    GetDataframeResponse:
      description: Response schema for getting a dataframe from a notebook session.
      properties:
        dataframe:
          description: The requested dataframe in the notebook session.
          title: Dataframe
          type: string
      required:
      - dataframe
      title: GetDataframeResponse
      type: object
    GetDatasetVersionProjectsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: Array of project references.
          items:
            $ref: '#/components/schemas/DatasetProject'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    GetFilesystemObjectMetadataRequest:
      description: Request payload values for getting filesystem object metadata.
      properties:
        path:
          description: List of paths to get metadata for.
          items:
            type: string
          title: Path
          type: array
      title: GetFilesystemObjectMetadataRequest
      type: object
    GitCloneRequest:
      description: Request schema for cloning a Git repository.
      properties:
        url:
          description: URL of the Git repository to clone.
          format: uri
          maxLength: 65536
          minLength: 1
          title: Url
          type: string
      required:
      - url
      title: GitCloneRequest
      type: object
    GitCloneStatusResponse:
      description: Response schema for the status of a Git clone operation.
      properties:
        errorMsg:
          description: Error message if the clone operation failed.
          title: Errormsg
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/VCSCommandStatus'
          description: Status of the Git clone operation.
      required:
      - status
      title: GitCloneStatusResponse
      type: object
    GitModelVersion:
      description: Contains git related attributes that are associated with a custom
        model version.
      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
          type:
          - string
          - 'null'
        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
    GitProviderSchema:
      description: The Git OAuth Provider details.
      properties:
        hostname:
          description: The hostname of the Git provider.
          title: Hostname
          type: string
        id:
          description: The authorized Git OAuth Provider ID.
          title: Id
          type: string
        name:
          description: The name of the Git provider.
          title: Name
          type: string
        settingsUrl:
          description: The URL to manage the Git provider settings.
          title: Settingsurl
          type: string
        status:
          description: The status of the OAuth authorization.
          title: Status
          type: string
        type:
          description: The type of the Git provider.
          title: Type
          type: string
      required:
      - id
      - status
      - type
      - name
      - hostname
      title: GitProviderSchema
      type: object
    GitRepositorySchema:
      properties:
        createdAt:
          description: The creation date of the Git repository.
          format: date-time
          title: Createdat
          type: string
        fullName:
          description: The full name of Git repository, e.g., datarobot/notebooks.
          title: Fullname
          type: string
        httpUrl:
          description: The HTTP URL of the Git repository, e.g., https://github.com/datarobot/notebooks.
          title: Httpurl
          type: string
        isPrivate:
          description: Determines if the Git repository is private.
          title: Isprivate
          type: boolean
        name:
          description: The name of Git repository, e.g., "notebooks".
          title: Name
          type: string
        owner:
          description: The owner account of the Git repository.
          title: Owner
          type: string
        pushedAt:
          description: The last push date of the Git repository.
          format: date-time
          title: Pushedat
          type: string
        updatedAt:
          description: The last update date of the Git repository.
          format: date-time
          title: Updatedat
          type: string
      required:
      - name
      - fullName
      - httpUrl
      - owner
      title: GitRepositorySchema
      type: object
    GlobalMetrics:
      description: average metrics across all classes
      properties:
        f1:
          description: Average F1 score
          type: number
        precision:
          description: Average precision score
          type: number
        recall:
          description: Average recall score
          type: number
      required:
      - f1
      - precision
      - recall
      type: object
    GradingResult:
      description: Grading result.
      enum:
      - PASS
      - FAIL
      title: GradingResult
      type: string
    GrantAccessControlWithId:
      additionalProperties: false
      description: 'Grant access control request using ID for recipient identification.


        Can be used for users, groups, or organizations.'
      properties:
        id:
          description: The ID of the recipient.
          title: Id
          type: string
        role:
          $ref: '#/components/schemas/SharingRole'
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - NO_ROLE
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          $ref: '#/components/schemas/SubjectType'
          description: "Describes the recipient type \u2014 one of user, group, organization,\
            \ or externalApplication."
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - role
      - shareRecipientType
      title: GrantAccessControlWithId
      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.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - NO_ROLE
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          description: "Describes the recipient type \u2014 one of user, group, organization,\
            \ or externalApplication."
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
    GrantAccessControlWithUsername:
      additionalProperties: false
      description: Grant access control request using username for user identification.
      properties:
        role:
          $ref: '#/components/schemas/SharingRole'
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - NO_ROLE
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          $ref: '#/components/schemas/SubjectType'
          description: "Describes the recipient type \u2014 one of user, group, organization,\
            \ or externalApplication."
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
        username:
          description: Username of the user to update the access role for.
          title: Username
          type: string
      required:
      - role
      - shareRecipientType
      - username
      title: GrantAccessControlWithUsername
      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.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - NO_ROLE
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          description: "Describes the recipient type \u2014 one of user, group, organization,\
            \ or externalApplication."
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
        username:
          description: The username of the user to update the access role for.
          type: string
      required:
      - role
      - shareRecipientType
      - username
      type: object
    GridSearchArgument:
      description: The details of the grid search configuration.
      properties:
        algorithm:
          default: Pattern Search
          description: The algorithm to apply when running the grid search.
          enum:
          - Pattern Search
          - Accelerated Search
          - Exhaustive Search
          - Greedy Exhaustive Search
          - Bayesian TPE Search
          - Bayesian GP Search
          type: string
        batchSize:
          default: 2
          description: The number of iterations to perform in each batch.
          maximum: 8
          minimum: 1
          type: integer
        maxIterations:
          default: 100
          description: Sets the maximum number of iterations to perform.
          maximum: 10000
          minimum: 1
          type: integer
        randomState:
          default: 42
          description: The random state/seed used for the grid search.
          minimum: 0
          type: integer
        searchType:
          default: smart
          description: The type of grid search to be performed. If not specified,
            DataRobot performs Smart Search.
          enum:
          - full
          - smart
          - bayesian
          type: string
        wallClockTimeLimit:
          default: 300
          description: The wall clock time limit, in seconds. The model with the best
            score, at this point, is selected.
          maximum: 604800
          minimum: 1
          type: integer
      type: object
      x-versionadded: v2.38
    GridSearchScoresRetrieveResponse:
      properties:
        id:
          description: The grid search scores metadata ID.
          type: string
        modelId:
          description: The ID of the model that scores belong to.
          type: string
        parameters:
          description: The list of grid search parameters.
          items:
            items:
              $ref: '#/components/schemas/ParameterItem'
            type: array
          maxItems: 100000
          minItems: 1
          type: array
        projectId:
          description: The project the model belongs to.
          type: string
        scores:
          description: The list of grid search scores.
          items:
            type: number
          maxItems: 100000
          minItems: 1
          type: array
        source:
          description: The source for the scores. If omitted, the validation partition
            is used.
          enum:
          - validation
          type: string
      required:
      - id
      - modelId
      - parameters
      - projectId
      - scores
      - source
      type: object
      x-versionadded: v2.39
    GroupRuntime:
      additionalProperties: false
      description: Runtime configuration for a single container group.
      properties:
        autoscaling:
          anyOf:
          - $ref: '#/components/schemas/AutoscalingProperties'
          - type: 'null'
          description: Autoscaling configuration for this group. Takes precedence
            over replicaCount.
        bundleSelectionPolicy:
          $ref: '#/components/schemas/BundleSelectionPolicy'
          default: availability
          description: 'How to select among resourceBundles. Default: availability.'
        containers:
          description: Per-container overrides for this group.
          items:
            $ref: '#/components/schemas/ContainerOverride'
          title: Containers
          type: array
        name:
          default: default
          description: Group name. Must match a container group name declared in the
            artifact.
          title: Name
          type: string
        replicaCount:
          anyOf:
          - minimum: 1.0
            type: integer
          - type: 'null'
          default: 1
          description: Number of replicas. Cannot be set alongside autoscaling.enabled=true.
          title: Replicacount
        resolvedBundle:
          anyOf:
          - $ref: '#/components/schemas/ResolvedBundle'
          - type: 'null'
          description: Full details of the bundle selected at scheduling time. Read-only.
          readOnly: true
        resourceBundles:
          description: Ordered list of bundle IDs. One is selected at scheduling time.
          items:
            type: string
          title: Resourcebundles
          type: array
      title: GroupRuntime
      type: object
    GuardAdditionalConfig:
      description: Additional configuration for the guard.
      properties:
        agentGuideline:
          description: How to calculate agent guideline adherence for this guard.
          maxLength: 4096
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        cost:
          $ref: '#/components/schemas/GuardConfigurationCostInfo'
        toolCall:
          $ref: '#/components/schemas/GuardToolCallInfo'
      type: object
      x-versionadded: v2.37
    GuardCondition:
      description: The guard condition for a metric.
      properties:
        comparand:
          anyOf:
          - type: number
          - type: string
          - type: boolean
          - items:
              type: string
            type: array
          description: The comparand(s) used in the guard condition.
          title: comparand
        comparator:
          $ref: '#/components/schemas/GuardConditionComparator'
          description: The comparator used in the guard condition.
      required:
      - comparator
      - comparand
      title: GuardCondition
      type: object
    GuardConditionComparator:
      description: The comparator used in a guard condition.
      enum:
      - greaterThan
      - lessThan
      - equals
      - notEquals
      - is
      - isNot
      - matches
      - doesNotMatch
      - contains
      - doesNotContain
      title: GuardConditionComparator
      type: string
    GuardConditionResponse:
      description: The condition to trigger intervention.
      properties:
        comparand:
          anyOf:
          - type: boolean
          - type: number
          - type: string
          - items:
              description: The class name to match.
              maxLength: 128
              type: string
            maxItems: 10
            type: array
          description: The condition comparand (basis of comparison).
        comparator:
          description: The condition comparator (operator).
          enum:
          - greaterThan
          - lessThan
          - equals
          - notEquals
          - is
          - isNot
          - matches
          - doesNotMatch
          - contains
          - doesNotContain
          type: string
      required:
      - comparand
      - comparator
      type: object
      x-versionadded: v2.35
    GuardConfigurationConditionResponse:
      description: The condition to trigger intervention.
      properties:
        comparand:
          anyOf:
          - type: boolean
          - type: number
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
          description: The condition comparand (basis of comparison).
        comparator:
          description: The condition comparator (operator).
          enum:
          - greaterThan
          - lessThan
          - equals
          - notEquals
          - is
          - isNot
          - matches
          - doesNotMatch
          - contains
          - doesNotContain
          type: string
      required:
      - comparand
      - comparator
      type: object
      x-versionadded: v2.35
    GuardConfigurationCostInfo:
      description: How to calculate cost information for this guard.
      properties:
        currency:
          description: ISO 4217 Currency code for display.
          maxLength: 255
          type: string
        inputPrice:
          description: Cost per unit measure of tokens for input.
          minimum: 0.0
          type: number
        inputUnit:
          description: Number of tokens related to input price.
          minimum: 0
          type: integer
        outputPrice:
          description: Cost per unit measure of tokens for output.
          minimum: 0.0
          type: number
        outputUnit:
          description: Number of tokens related to output price.
          minimum: 0
          type: integer
      required:
      - currency
      - inputPrice
      - inputUnit
      - outputPrice
      - outputUnit
      type: object
      x-versionadded: v2.37
    GuardConfigurationCreate:
      properties:
        additionalGuardConfig:
          $ref: '#/components/schemas/GuardAdditionalConfig'
          x-versionadded: v2.37
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
          x-versionadded: v2.36
        awsAccount:
          description: The ID of the user credential containing an AWS account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsModel:
          description: AWS model.
          enum:
          - amazon-titan
          - anthropic-claude-2
          - anthropic-claude-3-haiku
          - anthropic-claude-3-sonnet
          - anthropic-claude-3-opus
          - anthropic-claude-3.5-sonnet-v1
          - anthropic-claude-3.5-sonnet-v2
          - amazon-nova-lite
          - amazon-nova-micro
          - amazon-nova-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsRegion:
          description: AWS model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        deploymentId:
          description: The ID of the deployed model for model guards.
          type:
          - string
          - 'null'
        description:
          description: Guard configuration description
          maxLength: 4096
          type: string
        entityId:
          description: The ID of the custom model or playground for this guard.
          type: string
        entityType:
          description: The type of the associated entity.
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
        googleModel:
          description: Google model.
          enum:
          - chat-bison
          - google-gemini-1.5-flash
          - google-gemini-1.5-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleRegion:
          description: Google model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleServiceAccount:
          description: The ID of the user credential containing a Google service account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        intervention:
          $ref: '#/components/schemas/GuardConfigurationInterventionResponse'
        llmGatewayModelId:
          description: The LLM Gateway model ID to use as judge.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        llmType:
          description: The type of LLM used by this guard.
          enum:
          - openAi
          - azureOpenAi
          - google
          - amazon
          - datarobot
          - nim
          - llmGateway
          type:
          - string
          - 'null'
        modelInfo:
          $ref: '#/components/schemas/GuardConfigurationPayloadModelInfo'
        name:
          description: Guard configuration name
          maxLength: 255
          type: string
        nemoInfo:
          $ref: '#/components/schemas/GuardConfigurationNemoInfoResponse'
        nemoLlmJudgeConfig:
          $ref: '#/components/schemas/GuardNemoLlmJudgeConfigResponse'
          x-versionadded: v2.42
        nemoResponseRelevancyConfig:
          $ref: '#/components/schemas/GuardNemoResponseRelevancyConfigResponse'
          x-versionadded: v2.42
        nemoTopicAdherenceConfig:
          $ref: '#/components/schemas/GuardNemoTopicAdherenceConfigResponse'
          x-versionadded: v2.42
        openaiApiBase:
          description: The Azure OpenAI API Base URL.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiApiKey:
          description: Deprecated; use openai_credential instead.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiCredential:
          description: The ID of the user credential containing an OpenAI token.
          type:
          - string
          - 'null'
        openaiDeploymentId:
          description: The OpenAPI deployment ID.
          maxLength: 255
          type:
          - string
          - 'null'
        stages:
          description: The stages where the guard can run.
          items:
            enum:
            - prompt
            - response
            type: string
          maxItems: 16
          type: array
        templateId:
          description: The ID of the template this guard is based on.
          type: string
      required:
      - entityId
      - entityType
      - name
      - stages
      - templateId
      type: object
      x-versionadded: v2.35
    GuardConfigurationFullPost:
      description: Complete guard configuration to push
      properties:
        additionalGuardConfig:
          $ref: '#/components/schemas/GuardAdditionalConfig'
          x-versionadded: v2.37
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
          x-versionadded: v2.36
        awsAccount:
          description: The ID of the user credential containing an AWS account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsModel:
          description: AWS model.
          enum:
          - amazon-titan
          - anthropic-claude-2
          - anthropic-claude-3-haiku
          - anthropic-claude-3-sonnet
          - anthropic-claude-3-opus
          - anthropic-claude-3.5-sonnet-v1
          - anthropic-claude-3.5-sonnet-v2
          - amazon-nova-lite
          - amazon-nova-micro
          - amazon-nova-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsRegion:
          description: AWS model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        deploymentId:
          description: The ID of the deployed model for model guards.
          type:
          - string
          - 'null'
        description:
          description: Guard configuration description
          maxLength: 4096
          type: string
        errorMessage:
          description: Error message if the guard configuration is invalid.
          type:
          - string
          - 'null'
        googleModel:
          description: Google model.
          enum:
          - chat-bison
          - google-gemini-1.5-flash
          - google-gemini-1.5-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleRegion:
          description: Google model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleServiceAccount:
          description: The ID of the user credential containing a Google service account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        intervention:
          $ref: '#/components/schemas/GuardConfigurationInterventionResponse'
        isAgentic:
          default: false
          description: True if the guard is suitable for agentic workflows only.
          type: boolean
          x-versionadded: v2.37
        isValid:
          description: Whether the guard is valid or not.
          type: boolean
        llmGatewayModelId:
          description: The LLM Gateway model ID to use as judge.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        llmType:
          description: The type of LLM used by this guard.
          enum:
          - openAi
          - azureOpenAi
          - google
          - amazon
          - datarobot
          - nim
          - llmGateway
          type:
          - string
          - 'null'
        modelInfo:
          $ref: '#/components/schemas/GuardModelInfoResponse'
        name:
          description: Guard configuration name
          maxLength: 255
          type: string
        nemoEvaluatorType:
          description: Guard configuration "NeMo Evaluator" metric type
          enum:
          - llm_judge
          - context_relevance
          - response_groundedness
          - topic_adherence
          - agent_goal_accuracy
          - response_relevancy
          - faithfulness
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        nemoInfo:
          $ref: '#/components/schemas/GuardConfigurationNemoInfoResponse'
        nemoLlmJudgeConfig:
          $ref: '#/components/schemas/GuardNemoLlmJudgeConfigResponse'
          x-versionadded: v2.42
        nemoResponseRelevancyConfig:
          $ref: '#/components/schemas/GuardNemoResponseRelevancyConfigResponse'
          x-versionadded: v2.42
        nemoTopicAdherenceConfig:
          $ref: '#/components/schemas/GuardNemoTopicAdherenceConfigResponse'
          x-versionadded: v2.42
        ootbType:
          description: Guard template "Out of the Box" metric type
          enum:
          - token_count
          - faithfulness
          - rouge_1
          - agent_goal_accuracy
          - agent_goal_accuracy_with_reference
          - cost
          - task_adherence
          - tool_call_accuracy
          - agent_guideline_adherence
          - agent_latency
          - agent_tokens
          - agent_cost
          - agentGoalAccuracy
          - agentGoalAccuracyWithReference
          - taskAdherence
          - toolCallAccuracy
          type:
          - string
          - 'null'
        openaiApiBase:
          description: The Azure OpenAI API Base URL.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiApiKey:
          description: Deprecated; use openai_credential instead.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiCredential:
          description: The ID of the user credential containing an OpenAI token.
          type:
          - string
          - 'null'
        openaiDeploymentId:
          description: The OpenAI deployment ID.
          maxLength: 255
          type:
          - string
          - 'null'
        parameters:
          description: Parameter list, not used, deprecated.
          items:
            maxLength: 1
            type: string
          maxItems: 1
          type: array
        stages:
          description: The stages where the guard is configured to run.
          items:
            enum:
            - prompt
            - response
            type: string
          maxItems: 16
          type: array
        type:
          description: The guard configuration type.
          enum:
          - guardModel
          - nemo
          - nemoEvaluator
          - ootb
          - pii
          - userModel
          type: string
      required:
      - description
      - name
      - stages
      - type
      type: object
      x-versionadded: v2.35
    GuardConfigurationInterventionResponse:
      description: Intervention configuration for the guard.
      properties:
        action:
          description: The action to take if conditions are met.
          enum:
          - block
          - report
          - replace
          type: string
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
        conditionLogic:
          default: any
          description: The action to take if conditions are met.
          enum:
          - any
          type: string
        conditions:
          description: The list of conditions to trigger intervention.
          items:
            $ref: '#/components/schemas/GuardConfigurationConditionResponse'
          maxItems: 1
          type: array
        message:
          description: The message to use if the prompt or response is blocked.
          maxLength: 4096
          type: string
        sendNotification:
          default: false
          description: The notification event to create if intervention is triggered.
          type: boolean
      required:
      - action
      - conditions
      - message
      type: object
      x-versionadded: v2.35
    GuardConfigurationListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of guard configurations.
          items:
            $ref: '#/components/schemas/GuardConfigurationRetrieveResponse'
          maxItems: 200
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    GuardConfigurationNemoInfoResponse:
      description: The configuration info for NeMo guards.
      properties:
        actions:
          description: The NeMo guardrails actions file.
          maxLength: 4096
          type: string
        blockedTerms:
          description: The NeMo guardrails blocked terms list.
          maxLength: 4096
          type: string
        credentialId:
          description: The NeMo guardrails credential ID (deprecated; use "openai_credential").
          type:
          - string
          - 'null'
        llmPrompts:
          description: The NeMo guardrails prompts.
          maxLength: 4096
          type: string
        mainConfig:
          description: The overall NeMo configuration YAML.
          maxLength: 4096
          type: string
        railsConfig:
          description: The NeMo guardrails configuration Colang.
          maxLength: 4096
          type: string
      required:
      - blockedTerms
      - mainConfig
      - railsConfig
      type: object
      x-versionadded: v2.35
    GuardConfigurationPayloadModelInfo:
      description: The configuration info for guards using deployed models.
      properties:
        classNames:
          description: The list of class names for multiclass models.
          items:
            description: The class name.
            maxLength: 128
            type: string
          maxItems: 100
          type: array
        inputColumnName:
          description: The input column name.
          maxLength: 255
          type: string
        modelId:
          description: The ID of the registered model for model guards.
          type:
          - string
          - 'null'
        modelName:
          default: ''
          description: The ID of the registered model for .model guards.
          maxLength: 255
          type: string
        outputColumnName:
          description: The output column name.
          maxLength: 255
          type: string
        replacementTextColumnName:
          default: ''
          description: The name of the output column with replacement text. Required
            only if intervention.action is `replace`.
          maxLength: 255
          type: string
        targetType:
          description: The target type.
          enum:
          - Binary
          - Regression
          - Multiclass
          - TextGeneration
          type:
          - string
          - 'null'
      required:
      - inputColumnName
      - outputColumnName
      type: object
      x-versionadded: v2.35
    GuardConfigurationPredictionEnvironmentsInUseListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: list of prediction environments in use for this custom model
            version.
          items:
            $ref: '#/components/schemas/PredictionEnvironmentInUseResponse'
          maxItems: 32
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    GuardConfigurationRetrieveResponse:
      properties:
        additionalGuardConfig:
          $ref: '#/components/schemas/GuardAdditionalConfig'
          x-versionadded: v2.37
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
          x-versionadded: v2.36
        awsAccount:
          description: The ID of the user credential containing an AWS account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsModel:
          description: AWS model.
          enum:
          - amazon-titan
          - anthropic-claude-2
          - anthropic-claude-3-haiku
          - anthropic-claude-3-sonnet
          - anthropic-claude-3-opus
          - anthropic-claude-3.5-sonnet-v1
          - anthropic-claude-3.5-sonnet-v2
          - amazon-nova-lite
          - amazon-nova-micro
          - amazon-nova-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsRegion:
          description: AWS model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        createdAt:
          description: When the configuration was created.
          format: date-time
          type: string
        creatorId:
          description: The ID of the user who created the guard configuration.
          type:
          - string
          - 'null'
        creatorName:
          description: The name of the user who created the guard configuration.
          maxLength: 1000
          type: string
        deploymentId:
          description: The ID of the deployed model for model guards.
          type:
          - string
          - 'null'
        description:
          description: The guard configuration description.
          maxLength: 4096
          type: string
        entityId:
          description: The ID of the custom model or playground for this guard.
          type:
          - string
          - 'null'
        entityType:
          description: The type of the associated entity.
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
        errorMessage:
          description: Error message if the guard configuration is invalid.
          type:
          - string
          - 'null'
        googleModel:
          description: Google model.
          enum:
          - chat-bison
          - google-gemini-1.5-flash
          - google-gemini-1.5-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleRegion:
          description: Google model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleServiceAccount:
          description: The ID of the user credential containing a Google service account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        id:
          description: The guard configuration object ID.
          type: string
        intervention:
          $ref: '#/components/schemas/GuardConfigurationInterventionResponse'
        isAgentic:
          default: false
          description: True if the guard is suitable for agentic workflows only.
          type: boolean
          x-versionadded: v2.37
        isValid:
          description: Whether the guard is valid or not.
          type: boolean
        llmGatewayModelId:
          description: The LLM Gateway model ID to use as judge.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        llmType:
          description: The type of LLM used by this guard.
          enum:
          - openAi
          - azureOpenAi
          - google
          - amazon
          - datarobot
          - nim
          - llmGateway
          type:
          - string
          - 'null'
        modelInfo:
          $ref: '#/components/schemas/GuardModelInfoResponse'
        name:
          description: The guard configuration name.
          maxLength: 255
          type: string
        nemoEvaluatorType:
          description: Guard configuration "NeMo Evaluator" metric type
          enum:
          - llm_judge
          - context_relevance
          - response_groundedness
          - topic_adherence
          - agent_goal_accuracy
          - response_relevancy
          - faithfulness
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        nemoInfo:
          $ref: '#/components/schemas/GuardConfigurationNemoInfoResponse'
        nemoLlmJudgeConfig:
          $ref: '#/components/schemas/GuardNemoLlmJudgeConfigResponse'
          x-versionadded: v2.42
        nemoResponseRelevancyConfig:
          $ref: '#/components/schemas/GuardNemoResponseRelevancyConfigResponse'
          x-versionadded: v2.42
        nemoTopicAdherenceConfig:
          $ref: '#/components/schemas/GuardNemoTopicAdherenceConfigResponse'
          x-versionadded: v2.42
        ootbType:
          description: Guard template "Out of the Box" metric type
          enum:
          - token_count
          - faithfulness
          - rouge_1
          - agent_goal_accuracy
          - agent_goal_accuracy_with_reference
          - cost
          - task_adherence
          - tool_call_accuracy
          - agent_guideline_adherence
          - agent_latency
          - agent_tokens
          - agent_cost
          - agentGoalAccuracy
          - agentGoalAccuracyWithReference
          - taskAdherence
          - toolCallAccuracy
          type:
          - string
          - 'null'
        openaiApiBase:
          description: The Azure OpenAI API Base URL.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiApiKey:
          description: Deprecated; use openai_credential instead.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiCredential:
          description: The ID of the user credential containing an OpenAI token.
          type:
          - string
          - 'null'
        openaiDeploymentId:
          description: The OpenAPI deployment ID.
          maxLength: 255
          type:
          - string
          - 'null'
        stages:
          description: The stages where the guard is configured to run.
          items:
            enum:
            - prompt
            - response
            type: string
          maxItems: 16
          type: array
        type:
          description: The guard configuration type.
          enum:
          - guardModel
          - nemo
          - nemoEvaluator
          - ootb
          - pii
          - userModel
          type: string
      required:
      - createdAt
      - description
      - entityId
      - entityType
      - id
      - name
      - stages
      - type
      type: object
      x-versionadded: v2.35
    GuardConfigurationToCustomModelResponse:
      properties:
        customModelVersionId:
          description: The ID of the new custom model version created.
          type: string
      required:
      - customModelVersionId
      type: object
      x-versionadded: v2.35
    GuardConfigurationToCustomModelVersion:
      properties:
        customModelId:
          description: The ID of the custom model the user is working with.
          type: string
        data:
          description: The list of complete guard configurations to push.
          items:
            $ref: '#/components/schemas/GuardConfigurationFullPost'
          maxItems: 200
          type: array
        overallConfig:
          $ref: '#/components/schemas/OverallConfigUpdate'
      required:
      - customModelId
      - data
      type: object
      x-versionadded: v2.35
    GuardConfigurationUpdate:
      properties:
        additionalGuardConfig:
          $ref: '#/components/schemas/GuardAdditionalConfig'
          x-versionadded: v2.37
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
          x-versionadded: v2.36
        awsAccount:
          description: The ID of the user credential containing an AWS account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsModel:
          description: AWS model.
          enum:
          - amazon-titan
          - anthropic-claude-2
          - anthropic-claude-3-haiku
          - anthropic-claude-3-sonnet
          - anthropic-claude-3-opus
          - anthropic-claude-3.5-sonnet-v1
          - anthropic-claude-3.5-sonnet-v2
          - amazon-nova-lite
          - amazon-nova-micro
          - amazon-nova-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsRegion:
          description: AWS model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        deploymentId:
          description: The ID of the deployed model for model guards.
          type:
          - string
          - 'null'
        description:
          description: Guard configuration description
          maxLength: 4096
          type: string
        googleModel:
          description: Google model.
          enum:
          - chat-bison
          - google-gemini-1.5-flash
          - google-gemini-1.5-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleRegion:
          description: Google model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleServiceAccount:
          description: The ID of the user credential containing a Google service account.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        intervention:
          $ref: '#/components/schemas/GuardConfigurationInterventionResponse'
        llmGatewayModelId:
          description: The LLM Gateway model ID to use as judge.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        llmType:
          description: The type of LLM used by this guard.
          enum:
          - openAi
          - azureOpenAi
          - google
          - amazon
          - datarobot
          - nim
          - llmGateway
          type:
          - string
          - 'null'
        modelInfo:
          $ref: '#/components/schemas/GuardConfigurationPayloadModelInfo'
        name:
          description: Guard configuration name
          maxLength: 255
          type: string
        nemoInfo:
          $ref: '#/components/schemas/GuardConfigurationNemoInfoResponse'
        nemoLlmJudgeConfig:
          $ref: '#/components/schemas/GuardNemoLlmJudgeConfigResponse'
          x-versionadded: v2.42
        nemoResponseRelevancyConfig:
          $ref: '#/components/schemas/GuardNemoResponseRelevancyConfigResponse'
          x-versionadded: v2.42
        nemoTopicAdherenceConfig:
          $ref: '#/components/schemas/GuardNemoTopicAdherenceConfigResponse'
          x-versionadded: v2.42
        openaiApiBase:
          description: The Azure OpenAI API Base URL.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiApiKey:
          description: Deprecated; use openai_credential instead.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiCredential:
          description: The ID of the user credential containing an OpenAI token.
          type:
          - string
          - 'null'
        openaiDeploymentId:
          description: The OpenAPI deployment ID.
          maxLength: 255
          type:
          - string
          - 'null'
      type: object
      x-versionadded: v2.35
    GuardInterventionResponse:
      description: The intervention configuration for the guard.
      properties:
        action:
          description: The action to take if conditions are met.
          enum:
          - block
          - report
          - replace
          type: string
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
        conditionLogic:
          default: any
          description: The action to take if conditions are met.
          enum:
          - any
          type: string
        conditions:
          description: The list of conditions to trigger intervention.
          items:
            $ref: '#/components/schemas/GuardConditionResponse'
          maxItems: 1
          type: array
        modifyMessage:
          description: The message to use if the prompt or response is blocked.
          maxLength: 4096
          type: string
        sendNotification:
          description: The notification event to create if intervention is triggered.
          type: boolean
      required:
      - action
      - conditions
      - modifyMessage
      type: object
      x-versionadded: v2.35
    GuardModelInfoResponse:
      description: The configuration info for guards using deployed models.
      properties:
        classNames:
          description: The list of class names for multiclass models.
          items:
            description: The class name.
            maxLength: 128
            type: string
          maxItems: 100
          type: array
        inputColumnName:
          description: The input column name.
          maxLength: 255
          type: string
        modelId:
          description: The ID of the registered model for model guards.
          type:
          - string
          - 'null'
        modelName:
          default: ''
          description: The ID of the registered model for .model guards.
          maxLength: 255
          type: string
        outputColumnName:
          description: The output column name.
          maxLength: 255
          type: string
        replacementTextColumnName:
          default: ''
          description: The name of the output column with replacement text. Required
            only if intervention.action is `replace`.
          maxLength: 255
          type: string
        targetType:
          description: The target type.
          enum:
          - Binary
          - Regression
          - Multiclass
          - TextGeneration
          type: string
      required:
      - inputColumnName
      - outputColumnName
      - targetType
      type: object
      x-versionadded: v2.35
    GuardNemoInfoResponse:
      description: The configuration info for NeMo guards.
      properties:
        actions:
          default: ''
          description: The NeMo guardrails actions.
          maxLength: 4096
          type: string
        blockedTerms:
          description: The NeMo guardrails blocked terms list.
          maxLength: 4096
          type: string
        credentialId:
          description: The NeMo guardrails credential ID.
          type:
          - string
          - 'null'
        llmPrompts:
          default: ''
          description: The NeMo guardrails prompts.
          maxLength: 4096
          type: string
        mainConfig:
          description: The overall NeMo configuration YAML.
          maxLength: 4096
          type: string
        railsConfig:
          description: The NeMo guardrails configuration Colang.
          maxLength: 4096
          type: string
      required:
      - blockedTerms
      - mainConfig
      - railsConfig
      type: object
      x-versionadded: v2.35
    GuardNemoLlmJudgeConfigResponse:
      description: The configuration for the LLM Judge metric.
      properties:
        customMetricDirectionality:
          description: The custom metric directionality for the LLM judge.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type: string
          x-versionadded: v2.42
        scoreParsingRegex:
          description: The regex to parse the score from the LLM judge response.
          maxLength: 1024
          type: string
        systemPrompt:
          description: The system prompt for the LLM judge.
          maxLength: 8192
          type: string
        userPrompt:
          description: The user prompt template for the LLM judge.
          maxLength: 8192
          type: string
      required:
      - customMetricDirectionality
      - scoreParsingRegex
      - systemPrompt
      - userPrompt
      type: object
      x-versionadded: v2.42
    GuardNemoResponseRelevancyConfigResponse:
      description: The configuration for the Response Relevancy metric.
      properties:
        embeddingDeploymentId:
          description: The ID of the embedding model deployment.
          type: string
      required:
      - embeddingDeploymentId
      type: object
      x-versionadded: v2.42
    GuardNemoTopicAdherenceConfigResponse:
      description: The configuration for the Topic Adherence metric.
      properties:
        metricMode:
          default: f1
          description: The metric calculation mode.
          enum:
          - f1
          - recall
          - precision
          type: string
        referenceTopics:
          description: The list of reference topics.
          items:
            description: The reference topic.
            maxLength: 512
            type: string
          maxItems: 100
          minItems: 1
          type: array
      required:
      - referenceTopics
      type: object
      x-versionadded: v2.42
    GuardTemplateListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of guard templates.
          items:
            $ref: '#/components/schemas/GuardTemplateRetrieveResponse'
          maxItems: 200
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    GuardTemplateRetrieveResponse:
      properties:
        allowedActions:
          description: The actions this guard is allowed to take.
          items:
            enum:
            - block
            - report
            - replace
            type: string
          maxItems: 10
          type: array
          x-versionadded: v2.36
        allowedStages:
          description: The stages where the guard can run.
          items:
            enum:
            - prompt
            - response
            type: string
          maxItems: 16
          type: array
        awsModel:
          description: AWS model.
          enum:
          - amazon-titan
          - anthropic-claude-2
          - anthropic-claude-3-haiku
          - anthropic-claude-3-sonnet
          - anthropic-claude-3-opus
          - anthropic-claude-3.5-sonnet-v1
          - anthropic-claude-3.5-sonnet-v2
          - amazon-nova-lite
          - amazon-nova-micro
          - amazon-nova-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        awsRegion:
          description: AWS model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        createdAt:
          description: When the template was created.
          format: date-time
          type: string
        creatorId:
          description: The ID of the user who created the guard template.
          type:
          - string
          - 'null'
        creatorName:
          description: The name of the user who created the guard template.
          maxLength: 1000
          type: string
        description:
          description: The guard template description.
          maxLength: 4096
          type: string
        errorMessage:
          description: Error message if the guard configuration is invalid.
          type:
          - string
          - 'null'
        googleModel:
          description: Google model.
          enum:
          - chat-bison
          - google-gemini-1.5-flash
          - google-gemini-1.5-pro
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        googleRegion:
          description: Google model region.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        id:
          description: The guard template object ID.
          type: string
        intervention:
          $ref: '#/components/schemas/GuardInterventionResponse'
        isAgentic:
          default: true
          description: True if the guard is suitable for agentic workflows only.
          type: boolean
          x-versionadded: v2.37
        isValid:
          default: true
          description: True if the guard is fully configured and valid.
          type: boolean
        labels:
          description: The list of short strings to associate with the template.
          items:
            description: A short string to associate with the template.
            maxLength: 255
            type: string
          maxItems: 16
          type: array
          x-versionadded: v2.37
        llmGatewayModelId:
          description: The LLM Gateway model ID to use as judge.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        llmType:
          description: The type of LLM used by this guard.
          enum:
          - openAi
          - azureOpenAi
          - google
          - amazon
          - datarobot
          - nim
          - llmGateway
          type:
          - string
          - 'null'
        modelInfo:
          $ref: '#/components/schemas/GuardModelInfoResponse'
        name:
          description: The guard template name.
          maxLength: 255
          type: string
        nemoEvaluatorType:
          description: The guard template "NeMo Evaluator" metric type.
          enum:
          - llm_judge
          - context_relevance
          - response_groundedness
          - topic_adherence
          - agent_goal_accuracy
          - response_relevancy
          - faithfulness
          type:
          - string
          - 'null'
          x-versionadded: v2.41
        nemoInfo:
          $ref: '#/components/schemas/GuardNemoInfoResponse'
        nemoLlmJudgeConfig:
          $ref: '#/components/schemas/GuardNemoLlmJudgeConfigResponse'
          x-versionadded: v2.42
        nemoResponseRelevancyConfig:
          $ref: '#/components/schemas/GuardNemoResponseRelevancyConfigResponse'
          x-versionadded: v2.42
        nemoTopicAdherenceConfig:
          $ref: '#/components/schemas/GuardNemoTopicAdherenceConfigResponse'
          x-versionadded: v2.42
        ootbType:
          description: The guard template "Out of the Box" metric type.
          enum:
          - token_count
          - faithfulness
          - rouge_1
          - agent_goal_accuracy
          - agent_goal_accuracy_with_reference
          - cost
          - task_adherence
          - tool_call_accuracy
          - agent_guideline_adherence
          - agent_latency
          - agent_tokens
          - agent_cost
          - agentGoalAccuracy
          - agentGoalAccuracyWithReference
          - taskAdherence
          - toolCallAccuracy
          type:
          - string
          - 'null'
        openaiApiBase:
          description: The Azure OpenAI API Base URL.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiApiKey:
          description: Deprecated; use openai_credential instead.
          maxLength: 255
          type:
          - string
          - 'null'
        openaiDeploymentId:
          description: The OpenAPI deployment ID.
          maxLength: 255
          type:
          - string
          - 'null'
        orgId:
          description: Organization ID of the user who created the Guard template.
          type:
          - string
          - 'null'
        playgroundOnly:
          description: Whether the guard is for playground only, or if it can be used
            in production and playground.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        productionOnly:
          description: Whether the guard is for production only, or if it can be used
            in production and playground.
          type:
          - boolean
          - 'null'
        type:
          description: The guard template type.
          enum:
          - guardModel
          - nemo
          - nemoEvaluator
          - ootb
          - pii
          - userModel
          type: string
      required:
      - allowedStages
      - createdAt
      - description
      - id
      - name
      - type
      type: object
      x-versionadded: v2.35
    GuardToolCallInfo:
      description: How to calculate tool call metrics for this guard.
      properties:
        comparisonMetric:
          description: How tool calls should be compared for metrics calculations.
          enum:
          - exactMatch
          - doNotCompare
          type: string
      required:
      - comparisonMetric
      type: object
      x-versionadded: v2.37
    HTTPAuthSecurityScheme:
      properties:
        bearerFormat:
          description: A hint to the client about the bearer token format (e.g. 'JWT').
          type:
          - string
          - 'null'
        description:
          description: A description of the HTTP auth security scheme.
          type:
          - string
          - 'null'
        scheme:
          description: The HTTP authentication scheme (e.g. 'bearer', 'basic').
          type: string
        type:
          default: http
          description: The security scheme type; must be 'http'.
          enum:
          - http
          type: string
      required:
      - scheme
      type: object
      x-versionadded: v2.46
    HTTPDataStreamer:
      description: Stream CSV data chunks from HTTP
      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:
      description: Stream CSV data chunks from HTTP
      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:
      description: Save CSV data chunks to HTTP data endpoint
      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
    HTTPValidationError:
      properties:
        detail:
          description: List of validation errors.
          items:
            $ref: '#/components/schemas/ValidationError'
          maxItems: 100
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    HTTPValidationErrorResponse:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: detail
          type: array
      title: HTTPValidationErrorResponse
      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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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 the 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'
          x-versionadded: v2.33
        actualsTimeliness:
          $ref: '#/components/schemas/TimelinessSettings'
          x-versionadded: v2.33
        customMetrics:
          $ref: '#/components/schemas/CustomMetricsHealth'
          x-versionadded: v2.33
        dataDrift:
          $ref: '#/components/schemas/DataDriftHealth'
          x-versionadded: v2.33
        fairness:
          $ref: '#/components/schemas/FairnessHealth'
          x-versionadded: v2.33
        predictionsTimeliness:
          $ref: '#/components/schemas/TimelinessSettings'
          x-versionadded: v2.33
        service:
          $ref: '#/components/schemas/ServiceHealth'
          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
    HistoryPoint:
      description: Represents a search trial from history.
      properties:
        llmBlueprintId:
          anyOf:
          - type: string
          - type: 'null'
          description: The correspondent blueprint ID.
          title: llmBlueprintId
        searchParameters:
          additionalProperties: true
          description: Search parameters of the point.
          title: searchParameters
          type: object
        values:
          description: The resulting values of optimization objectives.
          items:
            type: number
          title: values
          type: array
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The correspondent vector database ID.
          title: vectorDatabaseId
      required:
      - llmBlueprintId
      - vectorDatabaseId
      - values
      - searchParameters
      title: HistoryPoint
      type: object
    HoldoutDataResponse:
      description: Holdout data configuration.
      properties:
        datasetId:
          description: 'The ID of the dataset.                Should be provided only
            for unstructured models.                 '
          type:
          - string
          - 'null'
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          type:
          - string
          - 'null'
        datasetVersionId:
          description: 'The ID of the dataset version.                Should be provided
            only for unstructured models.                 '
          type:
          - string
          - 'null'
        partitionColumn:
          description: The name of the column containing the partition assignments.
          maxLength: 500
          type:
          - string
          - 'null'
      type: object
    HostedCustomMetricTemplateCreate:
      properties:
        categories:
          description: Values of the categories. This field is required for categorical
            custom metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        directionality:
          description: Directionality of the custom metric. This field is required
            for numeric custom metrics.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type:
          - string
          - 'null'
        isGeospatial:
          description: Determines whether the metric is geospatial.
          type: boolean
          x-versionadded: v2.36
        isModelSpecific:
          description: Determines whether the metric is related to the model or deployment.
          type: boolean
        timeStep:
          default: hour
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or the Y-axis label of the given custom metric. This
            field is required for numeric custom metrics.
          type:
          - string
          - 'null'
      required:
      - isModelSpecific
      - timeStep
      - type
      type: object
      x-versionadded: v2.34
    HostedCustomMetricTemplateResponse:
      properties:
        categories:
          description: Values of the categories. This field is required for categorical
            custom metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        createdAt:
          description: Hosted custom metric template creation timestamp.
          format: date-time
          type: string
        createdBy:
          description: ID of the user who created the hosted custom metric template.
          type: string
        customJobId:
          description: ID of the associatedCustom job.
          type: string
        directionality:
          description: Directionality of the custom metric. This field is required
            for numeric custom metrics.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type:
          - string
          - 'null'
        id:
          description: ID of the hosted custom metric template.
          type: string
        isGeospatial:
          description: Determines whether the metric is geospatial.
          type: boolean
          x-versionadded: v2.36
        isModelSpecific:
          description: Determines whether the metric is related to the model or deployment.
          type: boolean
        timeStep:
          default: hour
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or the Y-axis label of the given custom metric. This
            field is required for numeric custom metrics.
          type:
          - string
          - 'null'
        updatedAt:
          description: Hosted custom metric template update timestamp.
          format: date-time
          type: string
        updatedBy:
          description: ID of the user who updated the hosted custom metric template.
          type: string
      required:
      - createdAt
      - createdBy
      - customJobId
      - id
      - isModelSpecific
      - timeStep
      - type
      - updatedAt
      - updatedBy
      type: object
      x-versionadded: v2.34
    HostedCustomMetricTemplateUpdate:
      properties:
        categories:
          description: Values of the categories. This field is required for categorical
            custom metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        directionality:
          description: Directionality of the custom metric.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type: string
        isGeospatial:
          description: Determines whether the metric is geospatial.
          type: boolean
          x-versionadded: v2.36
        isModelSpecific:
          description: Determines whether the metric is related to the model or deployment.
          type: boolean
        timeStep:
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type: string
      type: object
      x-versionadded: v2.34
    HttpOutputAdaptor:
      description: Save CSV data chunks to HTTP data endpoint
      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:
      description: Humility setting for the deployment.
      properties:
        enabled:
          description: Indicates whether humility rules are enabled for the deployment.
          type: boolean
      required:
      - enabled
      type: object
    HumilityStatsBucket:
      description: A `bucket` object covering whole `start`/`end` time range
      properties:
        period:
          $ref: '#/components/schemas/TimeRange'
        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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/HumilityStatsBucket'
      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'
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          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.
          type:
          - object
          - 'null'
        errorMetric:
          description: 'Error Metric Eureqa used internally, to evaluate which models
            to keep on its internal Pareto Front. '
          type:
          - string
          - 'null'
        maxGenerations:
          description: The maximum number of evolutionary generations to run.
          minimum: 32
          type:
          - integer
          - 'null'
        numThreads:
          description: The number of threads Eureqa will run with.
          minimum: 0
          type:
          - integer
          - 'null'
        priorSolutions:
          description: Prior Eureqa Solutions.
          items:
            description: Prior solution.
            type: string
          type: array
        randomSeed:
          description: Constant to seed Eureqa's pseudo-random number generator.
          minimum: 0
          type:
          - integer
          - 'null'
        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'
          type:
          - string
          - 'null'
        syncMigrations:
          description: Whether Eureqa's migrations are synchronized.
          type:
          - boolean
          - 'null'
        targetExpressionFormat:
          description: Constrain the target expression to the specified format.
          enum:
          - None
          - exponential
          - featureInteraction
          type:
          - string
          - 'null'
        targetExpressionString:
          description: Eureqa Expression to constrain the form of the models that
            Eureqa will consider.
          type:
          - string
          - 'null'
        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
          type:
          - number
          - 'null'
        trainingFraction:
          description: The fraction of the DataRobot training data to use for Eureqa
            evolutionary training.
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        trainingSplitExpr:
          description: Valid Eureqa Expression to do Eureqa internal training splits.
          type:
          - string
          - 'null'
        validationFraction:
          description: The fraction of the DataRobot training data to use for Eureqa
            evolutionary validation.
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        validationSplitExpr:
          description: Valid Eureqa Expression to do Eureqa internal validation splits.
          type:
          - string
          - 'null'
        weightExpr:
          description: Eureqa Weight Expression.
          type:
          - string
          - 'null'
      required:
      - buildingBlocks
      - maxGenerations
      - numThreads
      - priorSolutions
      - randomSeed
      - splitMode
      - syncMigrations
      - targetExpressionFormat
      - targetExpressionString
      - timeoutSec
      - trainingFraction
      - trainingSplitExpr
      - validationFraction
      - validationSplitExpr
      - weightExpr
      type: object
    IdleTimeoutTrigger:
      additionalProperties: false
      description: 'Trigger based on time since the last event in the session.


        Fires when no new events were added to the session within the configured TTL.'
      properties:
        idle:
          description: Time in seconds since last event
          exclusiveMinimum: 0.0
          maximum: 63072000.0
          title: Idle
          type: integer
      required:
      - idle
      title: IdleTimeoutTrigger
      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
          type:
          - string
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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: The number of items returned on this page.
          type: integer
        data:
          description: Augmentation samples list
          items:
            $ref: '#/components/schemas/ImageAugmentationRetrieveSamplesItem'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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/`'
          type:
          - string
          - 'null'
        projectId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: Augmentation samples list
          items:
            $ref: '#/components/schemas/ImageAugmentationRetrieveSamplesItem'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImageBuildConfig:
      additionalProperties: false
      description: User-provided configuration for server-side image builds from source
        code.
      properties:
        codeRef:
          anyOf:
          - $ref: '#/components/schemas/CodeRef'
          - type: 'null'
          description: Reference to source code (e.g. Files API catalog). Optional
            at create time; required before build or lock.
        dockerfile:
          description: How the Dockerfile is obtained. Defaults to using ./Dockerfile
            from the source code.
          discriminator:
            mapping:
              generated: '#/components/schemas/GeneratedDockerfile'
              provided: '#/components/schemas/ProvidedDockerfile'
            propertyName: source
          oneOf:
          - $ref: '#/components/schemas/ProvidedDockerfile'
          - $ref: '#/components/schemas/GeneratedDockerfile'
          title: Dockerfile
      title: ImageBuildConfig
      type: object
    ImageBuildExternalStatus:
      description: Client-facing artifact image build status.
      enum:
      - PENDING
      - IN_PROGRESS
      - BUILT
      - COMPLETED
      - CANCELLED
      - FAILED
      - UNKNOWN
      title: ImageBuildExternalStatus
      type: string
    ImageBuildFormatted:
      additionalProperties: false
      description: "Build row formatted for GET \u2026/builds (same base fields as\
        \ other `*Formatted` API models)."
      properties:
        artifactId:
          description: Parent artifact id
          title: Artifact Id
          type: string
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Created At
          type: string
        creator:
          anyOf:
          - $ref: '#/components/schemas/UserData'
          - type: 'null'
          description: Owner user details including ID, username and email
          title: Creator
        id:
          description: Unique identifier of the entity
          title: ID
          type: string
        name:
          description: Name of the entity
          title: Name
          type: string
        status:
          $ref: '#/components/schemas/ImageBuildExternalStatus'
          default: UNKNOWN
          description: Reported build status
          title: Build Status
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updated At
          type: string
      required:
      - id
      - name
      - createdAt
      - updatedAt
      - artifactId
      title: ImageBuildFormatted
      type: object
    ImageBuildFormattedList:
      additionalProperties: false
      description: "Paginated list of formatted artifact image builds for GET \u2026\
        /builds."
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ImageBuildFormatted'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ImageBuildFormattedList
      type: object
    ImageBuildTriggerResponse:
      additionalProperties: false
      description: Response after requesting image build(s) for a draft artifact.
      properties:
        buildIds:
          description: Workload API artifact image build document ids (same strings
            returned as `build_id` on GET/DELETE build routes), one per distinct Files
            API catalog/version pair. Internal image build ids are not returned.
          items:
            type: string
          title: Buildids
          type: array
      required:
      - buildIds
      title: ImageBuildTriggerResponse
      type: object
    ImageEmbedding:
      properties:
        actualTargetValue:
          description: Actual target value of the dataset row
          oneOf:
          - type: string
          - type: number
          - items:
              type: string
            type: array
          - type: 'null'
        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'
      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.
          type:
          - number
          - 'null'
        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'
        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: The name of the feature.
          type: string
        modelId:
          description: The model ID of the target model.
          type: string
      required:
      - featureName
      - modelId
      type: object
    ImageMetadataListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
        targetBinRowCount:
          description: Number of rows in this target bin
          type: integer
        targetBinStart:
          description: Target value for bin start for regression, null for classification
          type:
          - integer
          - 'null'
        targetValue:
          description: Target value
          type: number
        width:
          description: Width of the image in pixels
          type: integer
      required:
      - height
      - imageId
      - targetBinRowCount
      - width
      type: object
    ImagePublic:
      description: This class is used to represent the public information of an image.
      properties:
        default:
          default: false
          description: Whether the image is the default image.
          title: Default
          type: boolean
        description:
          description: Image description.
          title: Description
          type: string
        environmentId:
          description: Environment ID.
          title: Environmentid
          type: string
        gpuOptimized:
          default: false
          description: Whether the image is GPU optimized.
          title: Gpuoptimized
          type: boolean
        id:
          description: Image ID.
          title: Id
          type: string
        label:
          description: Image label.
          title: Label
          type: string
        language:
          description: Image programming language.
          title: Language
          type: string
        languageVersion:
          description: Image programming language version.
          title: Languageversion
          type: string
        libraries:
          description: The preinstalled libraries in the image.
          items:
            type: string
          title: Libraries
          type: array
        name:
          description: Image name.
          title: Name
          type: string
      required:
      - id
      - name
      - description
      - language
      - languageVersion
      title: ImagePublic
      type: object
    ImagesDataQualityLogLinesResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ImplicitOAuthFlow:
      description: Configuration for the OAuth 2.0 Implicit flow.
      properties:
        authorizationUrl:
          description: The authorization URL for the implicit flow.
          type: string
        refreshUrl:
          description: The URL for refreshing tokens.
          type:
          - string
          - 'null'
        scopes:
          additionalProperties:
            type: string
          description: Available scopes mapping scope name to description.
          type: object
      required:
      - authorizationUrl
      - scopes
      type: object
      x-versionadded: v2.46
    ImportNotebookFromUrlRequest:
      description: Request payload values for importing a notebook from a URL.
      properties:
        includeOutput:
          default: true
          description: Whether to include the cell output of the notebook in the import.
          title: Includeoutput
          type: boolean
        name:
          description: The name of the notebook to be created upon import.
          title: Name
          type: string
        uri:
          description: The URL of the notebook to import.
          title: Uri
          type: string
        useCaseId:
          description: The ID of the Use Case to import the notebook into.
          title: Usecaseid
          type: string
      required:
      - uri
      title: ImportNotebookFromUrlRequest
      type: object
    ImportNotebookResponse:
      description: Imported notebook information.
      properties:
        id:
          description: The ID of the created notebook.
          title: Id
          type: string
        name:
          description: The name of the created notebook.
          title: Name
          type: string
      required:
      - id
      title: ImportNotebookResponse
      type: object
    InputArtifact:
      additionalProperties: false
      description: Request to create an artifact. An artifact is always created as
        a draft.
      properties:
        artifactRepositoryId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the artifact repository this artifact belongs to (for
            versioning support)
          title: Artifactrepositoryid
        description:
          default: ''
          description: Description of the artifact
          title: Description
          type: string
        name:
          description: Name of the artifact
          maxLength: 5000
          minLength: 1
          title: Name
          type: string
        spec:
          description: Artifact specification
          discriminator:
            mapping:
              nim: '#/components/schemas/NimArtifactSpec'
              service: '#/components/schemas/ServiceArtifactSpec'
            propertyName: type
          oneOf:
          - $ref: '#/components/schemas/ServiceArtifactSpec'
          - $ref: '#/components/schemas/NimArtifactSpec'
          title: Spec
        status:
          $ref: '#/components/schemas/ArtifactStatus'
          default: draft
          description: Artifact status
        type:
          $ref: '#/components/schemas/ArtifactType'
          default: service
          description: Artifact type
      required:
      - name
      - spec
      title: InputArtifact
      type: object
    InputParametersResponse:
      description: The input parameters corresponding to the suggested operations.
      properties:
        baselinePeriods:
          default:
          - 1
          description: A list of periodicities used to calculate naive target features.
          items:
            exclusiveMinimum: 0
            type: integer
          maxItems: 10
          minItems: 1
          type: array
        datetimePartitionColumn:
          description: The column that is used to order the data.
          type: string
        doNotDeriveColumns:
          default: []
          description: Columns to exclude from derivation; for them only the first
            lag is suggested.
          items:
            type: string
          maxItems: 200
          type: array
        excludeLowInfoColumns:
          default: true
          description: Whether to ignore columns with low signal (only include features
            that pass a "reasonableness" check that determines whether they contain
            information useful for building a generalizable model).
          type: boolean
        featureDerivationWindows:
          description: A list of rolling windows of past values, defined in terms
            of rows, that are used to derive features for the modeling dataset.
          items:
            exclusiveMinimum: 0
            maximum: 300
            type: integer
          maxItems: 5
          minItems: 1
          type: array
        featureReductionThreshold:
          default: 0.9
          description: Threshold for feature reduction. For example, 0.9 means that
            features which cumulatively reach 90 % of importance are returned. Additionally,
            no more than 200 features are returned.
          exclusiveMinimum: 0
          maximum: 1
          type:
          - number
          - 'null'
        forecastDistances:
          description: A list of forecast distances, which defines the number of rows
            into the future to predict.
          items:
            exclusiveMinimum: 0
            type: integer
          maxItems: 20
          minItems: 1
          type: array
        knownInAdvanceColumns:
          default: []
          description: Columns that are known in advance (future values are known).
            Values for these known columns must be specified at prediction time.
          items:
            type: string
          maxItems: 200
          type: array
        maxLagOrder:
          description: The maximum lag order. This value cannot be greater than the
            largest feature derivation window.
          exclusiveMinimum: 0
          maximum: 100
          type:
          - integer
          - 'null'
        multiseriesIdColumn:
          description: The series ID column, if present. This column partitions data
            to create a multiseries modeling project.
          type:
          - string
          - 'null'
        numberOfOperationsToUse:
          description: If set, a transformation plan is suggested after the specified
            number of operations.
          type: integer
        targetColumn:
          description: The column intended to be used as the target for modeling.
            This parameter is required for generating naive features.
          type: string
      required:
      - datetimePartitionColumn
      - featureDerivationWindows
      - forecastDistances
      - targetColumn
      type: object
      x-versionadded: v2.35
    InputReplySchema:
      description: The schema for the input reply request.
      properties:
        value:
          description: The value to send as a reply after kernel has requested input.
          title: Value
          type: string
      required:
      - value
      title: InputReplySchema
      type: object
    InsertCellsSchema:
      description: The schema for the cells to be inserted into a notebook.
      properties:
        afterCellId:
          anyOf:
          - type: string
          - enum:
            - FIRST
            type: string
          description: ID of the cell after which to insert the new cell.
          title: Aftercellid
        data:
          allOf:
          - $ref: '#/components/schemas/CreateNotebookCellSchema'
          description: The cell data to insert.
          title: Data
      required:
      - afterCellId
      - data
      title: InsertCellsSchema
      type: object
    InsightErrorResolution:
      description: Error type linking directly to the field name that is related to
        the error.
      enum:
      - ootbMetricName
      - intervention
      - guardCondition
      - sidecarOverall
      - sidecarRevalidate
      - sidecarDeploymentId
      - sidecarInputColumnName
      - sidecarOutputColumnName
      - promptPipelineFiles
      - promptPipelineTemplateId
      - responsePipelineFiles
      - responsePipelineTemplateId
      title: InsightErrorResolution
      type: string
    InsightEvaluationResultResponse:
      description: API response object for a single InsightEvaluationResult.
      properties:
        aggregationType:
          anyOf:
          - $ref: '#/components/schemas/AggregationType'
          - type: 'null'
          description: Aggregation type.
        aggregationValue:
          anyOf:
          - type: number
          - items:
              $ref: '#/components/schemas/AggregationValue'
            type: array
          - type: 'null'
          description: Aggregation value. None indicates that the aggregation failed.
          title: aggregationValue
        chatId:
          description: Chat ID.
          title: chatId
          type: string
        chatName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Chat name.
          title: chatName
        customModelLLMValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: Custom Model LLM Validation ID if using custom model LLM.
          title: customModelLLMValidationId
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: Evaluation dataset configuration ID.
          title: evaluationDatasetConfigurationId
        evaluationDatasetName:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Evaluation dataset name.
          title: evaluationDatasetName
        evaluationName:
          description: Evaluation name.
          maxLength: 5000
          title: evaluationName
          type: string
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          default: NEW
          description: The execution status of the insight evaluation result.
        gradingResult:
          anyOf:
          - $ref: '#/components/schemas/GradingResult'
          - type: 'null'
          description: The grading result for this insight evaluation result. If not
            specified, execution status is not COMPLETED.
        id:
          description: Insight evaluation result ID.
          title: id
          type: string
        insightGradingCriteria:
          $ref: '#/components/schemas/InsightGradingCriteria'
          description: Insight grading criteria.
        lastUpdateDate:
          description: Last update date of the insight evaluation result (ISO 8601
            formatted).
          format: date-time
          title: lastUpdateDate
          type: string
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: LLM ID used for this insight evaluation result.
          title: llmId
        llmTestResultId:
          description: LLM test result ID this insight evaluation result is associated
            to.
          title: llmTestResultId
          type: string
        maxNumPrompts:
          description: Number of prompts used in evaluation.
          title: maxNumPrompts
          type: integer
        metricName:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the metric.
          title: metricName
        promptSamplingStrategy:
          $ref: '#/components/schemas/PromptSamplingStrategy'
          description: Prompt sampling strategy for maxNumPrompts.
      required:
      - id
      - llmTestResultId
      - maxNumPrompts
      - promptSamplingStrategy
      - chatId
      - chatName
      - evaluationName
      - insightGradingCriteria
      - lastUpdateDate
      title: InsightEvaluationResultResponse
      type: object
    InsightGradingCriteria:
      description: Grading criteria for an insight.
      properties:
        passThreshold:
          description: The percentage threshold for Pass result. Greater than or equal
            to this threshold indicates a Pass.
          maximum: 100.0
          minimum: 0.0
          title: passThreshold
          type: integer
      required:
      - passThreshold
      title: InsightGradingCriteria
      type: object
    InsightToEvalDatasetsCompatibility:
      description: Insight to evaluation datasets compatibility.
      properties:
        incompatibleDatasets:
          description: The list of incompatible datasets.
          items:
            $ref: '#/components/schemas/DatasetIdentifier'
          title: incompatibleDatasets
          type: array
        insightName:
          description: The name of the insight.
          title: insightName
          type: string
      required:
      - insightName
      - incompatibleDatasets
      title: InsightToEvalDatasetsCompatibility
      type: object
    InsightTypes:
      description: The type of insight.
      enum:
      - Reference
      - Quality metric
      - Operational metric
      - Evaluation deployment
      - Custom metric
      - Nemo
      title: InsightTypes
      type: string
    InsightsConfigurationWithAdditionalData:
      description: The configuration of insights with extra data.
      properties:
        aggregationTypes:
          anyOf:
          - items:
              $ref: '#/components/schemas/AggregationType'
            type: array
          - type: 'null'
          description: The aggregation types used in the insights configuration.
          title: aggregationTypes
        costConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the cost configuration.
          title: costConfigurationId
        customMetricId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom metric (if using a custom metric).
          title: customMetricId
        customModelGuard:
          anyOf:
          - $ref: '#/components/schemas/CustomModelGuard'
          - type: 'null'
          description: Guard as configured in the custom model.
        customModelLLMValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model LLM validation if using a custom
            model LLM for OOTB metrics.
          title: customModelLLMValidationId
        deploymentId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model deployment associated with the insight.
          title: deploymentId
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the evaluation dataset configuration
            or sidecar model metric validation or OOTB metric.
          title: errorMessage
        errorResolution:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The error type associated with the insight error status and
            error message as an indicator of what fields needs to be edited if any.
          title: errorResolution
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset configuration.
          title: evaluationDatasetConfigurationId
        executionStatus:
          anyOf:
          - $ref: '#/components/schemas/ExecutionStatus'
          - type: 'null'
          description: The execution status of the evaluation dataset configuration.
        extraMetricSettings:
          anyOf:
          - $ref: '#/components/schemas/ExtraMetricSettings'
          - type: 'null'
          description: Extra settings for the metric that do not reference other entities.
        insightName:
          description: The name of the insight.
          maxLength: 5000
          minLength: 1
          title: insightName
          type: string
        insightType:
          anyOf:
          - $ref: '#/components/schemas/InsightTypes'
          - type: 'null'
          description: The type of the insight.
        isTransferable:
          default: false
          description: Indicates if insight can be transferred to production.
          title: isTransferable
          type: boolean
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: The LLM ID for OOTB metrics that use LLMs.
          title: llmId
        llmIsActive:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the LLM is active.
          title: llmIsActive
        llmIsDeprecated:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the LLM is deprecated and will be removed in a future
            release.
          title: llmIsDeprecated
        modelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the model associated with `deploymentId`.
          title: modelId
        modelPackageRegisteredModelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the registered model package associated with `deploymentId`.
          title: modelPackageRegisteredModelId
        moderationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithID'
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration associated with the insight configuration.
          title: moderationConfiguration
        nemoMetricId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the Nemo configuration.
          title: nemoMetricId
        ootbMetricId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the ootb metric (if using an ootb metric).
          title: ootbMetricId
        ootbMetricName:
          anyOf:
          - $ref: '#/components/schemas/OOTBMetricInsightNames'
          - $ref: '#/components/schemas/OOTBAgenticMetricInsightNames'
          - $ref: '#/components/schemas/OTELMetricInsightNames'
          - type: 'null'
          description: The OOTB metric name.
          title: ootbMetricName
        resultUnit:
          anyOf:
          - $ref: '#/components/schemas/MetricUnit'
          - type: 'null'
          description: The unit of measurement associated with the insight result.
        sidecarModelMetricMetadata:
          anyOf:
          - $ref: '#/components/schemas/SidecarModelMetricMetadata'
          - type: 'null'
          description: The metadata of the sidecar model metric (if using a sidecar
            model metric).
        sidecarModelMetricValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the sidecar model metric validation (if using a sidecar
            model metric).
          title: sidecarModelMetricValidationId
        stage:
          anyOf:
          - $ref: '#/components/schemas/PipelineStage'
          - type: 'null'
          description: The stage (prompt or response) where insight is calculated
            at.
      required:
      - insightName
      - aggregationTypes
      title: InsightsConfigurationWithAdditionalData
      type: object
    InsightsPredictionField:
      description: Object that describes prediction value of the dataset row.
      properties:
        labels:
          description: List of predicted label names corresponding to values.
          items:
            description: Predicted label
            type: string
          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:
      description: Section instructions
      properties:
        owner:
          description: Instructions owner
          type: string
        user:
          description: Instructions user
          type: string
      required:
      - owner
      - user
      type: object
    Int:
      description: Numeric constraints on an integer value. If present, indicates
        that this parameter's value may be a JSON integer.
      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:
      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.
      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
    IntegerSettingConstraints:
      description: Available constraints for integer settings.
      properties:
        maxValue:
          anyOf:
          - type: integer
          - type: 'null'
          description: The maximum value of the setting (inclusive).
          title: maxValue
        minValue:
          anyOf:
          - type: integer
          - type: 'null'
          description: The minimum value of the setting (inclusive).
          title: minValue
        type:
          const: integer
          default: integer
          description: The data type of the setting.
          title: type
          type: string
      title: IntegerSettingConstraints
      type: object
    InteractiveVariablesSchema:
      description: Interactive variables schema. For use with results from IPython's
        magic `%who_ls` command.
      properties:
        name:
          description: The name of the variable.
          title: Name
          type: string
        type:
          description: The type of the variable.
          title: Type
          type: string
      required:
      - name
      - type
      title: InteractiveVariablesSchema
      type: object
    Intervention:
      description: The intervention configuration for a metric.
      properties:
        action:
          $ref: '#/components/schemas/ModerationAction'
          description: The intervention strategy.
        message:
          description: The intervention message to replace the prediction when a guard
            condition is satisfied.
          minLength: 1
          title: message
          type: string
      required:
      - action
      - message
      title: Intervention
      type: object
    InviteJobNotificationData:
      properties:
        failedInvites:
          description: Failed invites.
          items:
            $ref: '#/components/schemas/FailedInviteData'
          maxItems: 20
          type: array
        jobId:
          description: The ID of the invite job.
          type:
          - string
          - 'null'
        statusId:
          description: The ID of the invite job status.
          type: string
          x-versionadded: v2.40
        successfulInvites:
          description: Successful invites.
          items:
            $ref: '#/components/schemas/SuccessfulInviteData'
          maxItems: 20
          type: array
      required:
      - failedInvites
      - jobId
      - statusId
      - successfulInvites
      type: object
      x-versionadded: v2.39
    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: The JDBC URL.
          type: string
      required:
      - driverId
      type: object
    JDBCDataStoreDetails:
      properties:
        driverId:
          description: The driver ID.
          type: string
        jdbcFieldSchemas:
          default: []
          description: The 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: The JDBC URL.
          type: string
      required:
      - driverId
      type: object
    JDBCDataStoreUpdate:
      properties:
        driverId:
          description: The 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: The JDBC URL.
          type: string
      type: object
    JDBCDataStreamer:
      description: Stream CSV data chunks from JDBC
      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
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the JDBC data source.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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: The 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: The name of the JDBC parameter.
          type: string
        value:
          description: The value of the JDBC parameter.
          type: string
      required:
      - name
      - value
      type: object
    JDBCIntake:
      description: Stream CSV data chunks from JDBC
      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.
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks via JDBC
      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.
          type:
          - string
          - 'null'
        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:
      description: Data source configuration.
      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
          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
    JdbcConnectionParameters:
      description: Optional connection parameters and credential properties as key-value
        pairs (e.g. user, password, ssl, timeout).
      type: object
      x-versionadded: v2.43
    JdbcDataPreview:
      properties:
        jdbcUrl:
          description: The JDBC URL.
          maxLength: 16384
          type: string
        maxRows:
          default: 1000
          description: The row limit for the preview. The default is 1,000 rows, and
            a maximum of 10,000 per request.
          maximum: 10000
          minimum: 0
          type: integer
        parameters:
          $ref: '#/components/schemas/JdbcConnectionParameters'
        sql:
          description: The SQL to execute.
          maxLength: 320000
          type: string
      required:
      - jdbcUrl
      - sql
      type: object
      x-versionadded: v2.43
    JdbcExecute:
      properties:
        jdbcUrl:
          description: The JDBC URL.
          maxLength: 16384
          type: string
        parameters:
          $ref: '#/components/schemas/JdbcConnectionParameters'
        sql:
          description: The SQL to execute.
          maxLength: 320000
          type: string
      required:
      - jdbcUrl
      - sql
      type: object
      x-versionadded: v2.45
    JdbcExecuteResponse:
      properties:
        message:
          description: Status message from the connector. Empty success responses
            return OK.
          maxLength: 320000
          type: string
      required:
      - message
      type: object
      x-versionadded: v2.45
    JdbcForeignKey:
      properties:
        foreignKey:
          $ref: '#/components/schemas/JdbcKeyInfo'
        keyType:
          description: The type of this key.
          enum:
          - '1'
          - '2'
          - '3'
          type: string
        name:
          description: The name of this key.
          type: string
        primaryKey:
          $ref: '#/components/schemas/JdbcKeyInfo'
      required:
      - keyType
      - primaryKey
      type: object
    JdbcKeyInfo:
      description: The referred primary key.
      properties:
        catalog:
          description: The catalog name.
          type: string
        column:
          description: The column name.
          type: string
        schema:
          description: The schema name.
          type: string
        table:
          description: The table name.
          type: string
      required:
      - catalog
      - column
      - table
      type: object
    JdbcOutputAdaptor:
      description: Save CSV data chunks via JDBC
      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
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the JDBC data source.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
          - 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
    JobErrorCode:
      description: Possible job error codes. This enum exists for consistency with
        the DataRobot Status API.
      enum:
      - 0
      - 1
      title: JobErrorCode
      type: integer
    JobExecutionState:
      description: Possible job states. Values match the DataRobot Status API.
      enum:
      - INITIALIZED
      - RUNNING
      - COMPLETED
      - ERROR
      - ABORTED
      - EXPIRED
      title: JobExecutionState
      type: string
    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: The URL pointing to the next page (if null, there is no next
            page).
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page (if null, there is no
            previous page).
          type:
          - string
          - 'null'
      required:
      - count
      - jobs
      - next
      - previous
      type: object
    JobRunTimeBasedForecastPointPolicy:
      description: Forecast point policy
      properties:
        configuration:
          $ref: '#/components/schemas/JobRunTimeBasedForecastPointPolicySettings'
        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:
      description: Customize if forecast point based on job run time needs to be shifted.
      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
    JobStatus:
      description: Represents a search study execution state.
      enum:
      - RUNNING
      - COMPLETED
      - STOPPED
      - FAILED
      title: JobStatus
      type: string
    JoinArguments:
      description: The transformation description.
      discriminator:
        propertyName: source
      oneOf:
      - properties:
          joinType:
            description: The join type between primary and secondary data sources.
            enum:
            - inner
            - left
            - cartesian
            type: string
          leftKeys:
            description: The list of columns to be used in the "ON" clause from the
              primary data source. Required for inner, left joins, not used for cartesian
              joins.
            items:
              type: string
            maxItems: 10000
            minItems: 1
            type: array
          rightDataSourceId:
            description: The ID of the input data source.
            type: string
          rightKeys:
            description: The list of columns to be used in the "ON" clause from a
              secondary data source. Required for inner, left joins, not used for
              cartesian joins.
            items:
              type: string
            maxItems: 10000
            minItems: 1
            type: array
          rightPrefix:
            description: Optional prefix to be added to all column names from the
              right table in the join result.
            type:
            - string
            - 'null'
          skip:
            default: false
            description: If True, this directive will be skipped during processing.
            type: boolean
          source:
            description: The source type.
            enum:
            - table
            type: string
        required:
        - joinType
        - rightDataSourceId
        - skip
        - source
        type: object
      x-versionadded: v2.34
    JupyterCellMetadata:
      description: The schema for the Jupyter cell metadata.
      properties:
        outputsHidden:
          default: false
          description: Whether the cell's outputs are hidden.
          title: Outputshidden
          type: boolean
        sourceHidden:
          default: false
          description: Whether the cell's source is hidden.
          title: Sourcehidden
          type: boolean
      title: JupyterCellMetadata
      type: object
    KernelExecutionStatus:
      description: Kernel execution status.
      enum:
      - busy
      - idle
      title: KernelExecutionStatus
      type: string
    KernelSchema:
      description: The schema for the notebook kernel.
      properties:
        executionState:
          allOf:
          - $ref: '#/components/schemas/KernelState'
          description: The execution state of the kernel.
        id:
          description: The ID of the kernel.
          title: Id
          type: string
        language:
          allOf:
          - $ref: '#/components/schemas/RuntimeLanguage'
          description: The programming language of the kernel. Possible values include
            'python', 'r'.
        name:
          description: The name of the kernel. Possible values include 'python3',
            'ir'.
          title: Name
          type: string
        running:
          default: false
          description: Whether the kernel is running.
          title: Running
          type: boolean
      required:
      - id
      - name
      - language
      - executionState
      title: KernelSchema
      type: object
    KernelSpecSchema:
      properties:
        displayName:
          description: Display name of the kernel. Possible values include 'R', 'Python
            3 (ipykernel)'.
          title: Displayname
          type: string
        language:
          allOf:
          - $ref: '#/components/schemas/RuntimeLanguage'
          description: Runtime language of the kernel. Possible values include 'python',
            'r'.
        name:
          description: Name of the kernel. Possible values include 'python3', 'ir'.
          title: Name
          type: string
      required:
      - name
      - displayName
      - language
      title: KernelSpecSchema
      type: object
    KernelSpecsResponse:
      description: Schema for the Codespace's kernel information.
      properties:
        default:
          description: The default kernel. Possible values include 'python3', 'ir'.
          title: Default
          type: string
        kernels:
          description: List of available kernels.
          items:
            $ref: '#/components/schemas/KernelSpecSchema'
          title: Kernels
          type: array
      required:
      - default
      title: KernelSpecsResponse
      type: object
    KernelState:
      description: "Event Sequences on Various Workflows:\n- On kernel created: CONNECTED\
        \ -> BUSY -> IDLE\n- On kernel restarted: RESTARTING -> STARTING -> BUSY ->\
        \ IDLE\n- On regular execution: IDLE -> BUSY -> IDLE\n- On execution interrupted:\
        \ IDLE -> BUSY -> INTERRUPTING -> IDLE\n- On execution with error: IDLE ->\
        \ BUSY -> IDLE -> INTERRUPTING -> IDLE\n- On kernel shut down via calling\
        \ the stop kernel endpoint:\n    DISCONNECTED (can be sent a few times) ->\
        \ NOT_RUNNING (after 5s)"
      enum:
      - connecting
      - disconnected
      - connected
      - starting
      - idle
      - busy
      - interrupting
      - restarting
      - not_running
      title: KernelState
      type: string
    KeyValuePair:
      properties:
        key:
          description: The key, a unique identifier for this item of metadata
          maxLength: 50
          type: string
        value:
          description: The value, the actual content for this item of metadata
          maxLength: 256
          type: string
      required:
      - key
      - value
      type: object
      x-versionadded: v2.37
    LLMBlueprintResponse:
      description: API response object for a single LLM blueprint.
      properties:
        creationDate:
          description: The creation date of the LLM blueprint (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created this LLM blueprint.
          title: creationUserId
          type: string
        creationUserName:
          description: The name of the user who created this LLM blueprint.
          title: creationUserName
          type: string
        customModelLLMErrorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message of the custom model LLM (if using a custom
            model LLM).
          title: customModelLLMErrorMessage
        customModelLLMErrorResolution:
          anyOf:
          - type: string
          - type: 'null'
          description: The suggested error resolution for the custom model LLM (if
            using a custom model LLM).
          title: customModelLLMErrorResolution
        customModelLLMValidationStatus:
          anyOf:
          - $ref: '#/components/schemas/CustomModelValidationStatus'
          - type: 'null'
          description: The validation status of the custom model LLM (if using a custom
            model LLM).
        description:
          description: The description of the LLM blueprint.
          title: description
          type: string
        id:
          description: The ID of the LLM blueprint.
          title: id
          type: string
        isActive:
          description: Whether the LLM specified in this blueprint is active in the
            current environment.
          title: isActive
          type: boolean
        isDeprecated:
          description: Whether the LLM specified in this blueprint is deprecated.
          title: isDeprecated
          type: boolean
        isSaved:
          description: If false, then this LLM blueprint is a draft and its settings
            can be changed. If true, then its settings are frozen and cannot be changed
            anymore.
          title: isSaved
          type: boolean
        isStarred:
          description: Specifies whether this LLM blueprint is starred.
          title: isStarred
          type: boolean
        lastUpdateDate:
          description: The date of the most recent update of this LLM blueprint (ISO
            8601 formatted).
          format: date-time
          title: lastUpdateDate
          type: string
        lastUpdateUserId:
          description: The ID of the user that made the most recent update to this
            LLM blueprint.
          title: lastUpdateUserId
          type: string
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM selected for this LLM blueprint.
          title: llmId
        llmName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the LLM used by this LLM blueprint.
          title: llmName
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: A key/value dictionary of LLM settings.
          title: llmSettings
        name:
          description: The name of the LLM blueprint.
          title: name
          type: string
        playgroundId:
          description: The ID of the playground this LLM blueprint belongs to.
          title: playgroundId
          type: string
        promptType:
          $ref: '#/components/schemas/PromptType'
          description: Specifies whether the chat history is submitted as context
            to the user prompt.
        retirementDate:
          anyOf:
          - format: date
            type: string
          - type: 'null'
          description: When the LLM is expected to be retired and no longer available
            for submitting new prompts.
          title: retirementDate
        vectorDatabaseErrorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message of the vector database associated with this
            LLM.
          title: vectorDatabaseErrorMessage
        vectorDatabaseErrorResolution:
          anyOf:
          - type: string
          - type: 'null'
          description: The suggested error resolution for the vector database associated
            with this LLM blueprint.
          title: vectorDatabaseErrorResolution
        vectorDatabaseFamilyId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database family associated with this LLM
            blueprint.
          title: vectorDatabaseFamilyId
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database linked to this LLM blueprint.
          title: vectorDatabaseId
        vectorDatabaseName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the vector database associated with this LLM blueprint.
          title: vectorDatabaseName
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettings'
          - type: 'null'
          description: A key/value dictionary of vector database settings.
        vectorDatabaseStatus:
          anyOf:
          - $ref: '#/components/schemas/ExecutionStatus'
          - type: 'null'
          description: The creation status of the vector database associated with
            this LLM blueprint.
      required:
      - id
      - name
      - description
      - isSaved
      - isStarred
      - promptType
      - playgroundId
      - llmName
      - creationDate
      - creationUserId
      - creationUserName
      - lastUpdateDate
      - lastUpdateUserId
      - vectorDatabaseName
      - vectorDatabaseStatus
      - vectorDatabaseErrorMessage
      - vectorDatabaseErrorResolution
      - customModelLLMValidationStatus
      - customModelLLMErrorMessage
      - customModelLLMErrorResolution
      - vectorDatabaseFamilyId
      - isActive
      - isDeprecated
      title: LLMBlueprintResponse
      type: object
    LLMBlueprintSnapshot:
      description: A snapshot in time of a LLMBlueprint's functional parameters.
      properties:
        description:
          description: The description of the LLMBlueprint at the time of snapshotting.
          title: description
          type: string
        id:
          description: The ID of the LLMBlueprint for which the snapshot was produced.
          title: id
          type: string
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM selected for this LLM blueprint.
          title: llmId
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: A key/value dictionary of LLM settings.
          title: llmSettings
        name:
          description: The name of the LLMBlueprint at the time of snapshotting.
          title: name
          type: string
        playgroundId:
          description: The playground id of the LLMBlueprint.
          title: playgroundId
          type: string
        promptType:
          $ref: '#/components/schemas/PromptType'
          description: The prompting type of the LLMBlueprint at the time of snapshotting.
        snapshotDate:
          description: The date when the snapshot was produced.
          format: date-time
          title: snapshotDate
          type: string
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database linked to this LLM blueprint.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettings'
          - type: 'null'
          description: A key/value dictionary of vector database settings.
      required:
      - id
      - name
      - description
      - playgroundId
      - promptType
      title: LLMBlueprintSnapshot
      type: object
    LLMConfig:
      description: Configuration of LLMs in the search space.
      properties:
        llmNames:
          description: List of LLM names to use.
          items:
            type: string
          title: llmNames
          type: array
        temperatureMax:
          default: 1.0
          description: Maximum temperature of an LLM.
          title: temperatureMax
          type: number
        temperatureMin:
          default: 0.0
          description: Minimum temperature of an LLM.
          title: temperatureMin
          type: number
        temperatureStep:
          default: 0.05
          description: Step size for LLM temperature.
          title: temperatureStep
          type: number
        topPMax:
          default: 1.0
          description: Maximum top_p of an LLM.
          title: topPMax
          type: number
        topPMin:
          default: 0.0
          description: Minimum top_p of an LLM.
          title: topPMin
          type: number
        topPStep:
          default: 0.05
          description: Step size for LLM top_p.
          title: topPStep
          type: number
      required:
      - llmNames
      title: LLMConfig
      type: object
    LLMCostConfigurationResponse:
      description: API request/response object for a cost configuration of a single
        LLM.
      properties:
        currencyCode:
          default: USD
          description: The arbitrary code code of the currency of `inputTokenPrice`
            and `outputTokenPrice`.
          maxLength: 7
          title: currencyCode
          type: string
        customModelLLMValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model LLM validation (if using a custom
            model LLM).
          title: customModelLLMValidationId
        inputTokenPrice:
          default: 0.01
          description: The price of processing `referenceInputTokenCount` input tokens.
          minimum: 0.0
          title: inputTokenPrice
          type: number
        llmId:
          description: The ID of the LLM associated with this cost configuration.
          title: llmId
          type: string
        outputTokenPrice:
          default: 0.01
          description: The price of processing `referenceOutputTokenCount` output
            tokens.
          minimum: 0.0
          title: outputTokenPrice
          type: number
        referenceInputTokenCount:
          default: 1000
          description: The number of input tokens corresponding to `inputTokenPrice`.
          minimum: 0.0
          title: referenceInputTokenCount
          type: integer
        referenceOutputTokenCount:
          default: 1000
          description: The number of output tokens corresponding to `outputTokenPrice`.
          minimum: 0.0
          title: referenceOutputTokenCount
          type: integer
      required:
      - llmId
      title: LLMCostConfigurationResponse
      type: object
    LLMReference:
      description: A reference link for an LLM.
      properties:
        name:
          description: Description of the reference document.
          title: name
          type: string
        url:
          anyOf:
          - type: string
          - type: 'null'
          description: URL of the reference document.
          title: url
      required:
      - name
      - url
      title: LLMReference
      type: object
    LLMSettingDefinition:
      description: Metadata describing a single setting.
      properties:
        constraints:
          anyOf:
          - discriminator:
              mapping:
                boolean: '#/components/schemas/BooleanSettingConstraints'
                float: '#/components/schemas/FloatSettingConstraints'
                integer: '#/components/schemas/IntegerSettingConstraints'
                list: '#/components/schemas/ListParameterConstraints'
                object_id: '#/components/schemas/ObjectIdSettingConstraints'
                string: '#/components/schemas/StringSettingConstraints'
              propertyName: type
            oneOf:
            - $ref: '#/components/schemas/IntegerSettingConstraints'
            - $ref: '#/components/schemas/FloatSettingConstraints'
            - $ref: '#/components/schemas/StringSettingConstraints'
            - $ref: '#/components/schemas/BooleanSettingConstraints'
            - $ref: '#/components/schemas/ObjectIdSettingConstraints'
            - $ref: '#/components/schemas/ListParameterConstraints'
          - type: 'null'
          description: The constraints for the LLM setting values.
          title: constraints
        defaultValue:
          anyOf:
          - type: boolean
          - type: integer
          - type: number
          - type: string
          - type: 'null'
          description: The default value of the LLM setting.
          title: defaultValue
        description:
          description: The description of the LLM setting.
          title: description
          type: string
        format:
          anyOf:
          - $ref: '#/components/schemas/SettingFormat'
          - type: 'null'
          description: The expected format of the value of the LLM setting.
        id:
          description: The ID of the LLM setting.
          title: id
          type: string
        isNullable:
          default: true
          description: 'Whether the setting allows null values (default: true).'
          title: isNullable
          type: boolean
        name:
          description: The name of the LLM setting.
          title: name
          type: string
        type:
          $ref: '#/components/schemas/SettingType'
          description: The data type of the LLM setting.
      required:
      - id
      - name
      - description
      - type
      - constraints
      - defaultValue
      title: LLMSettingDefinition
      type: object
    LLMTestConfigurationNonOOTBDatasetResponse:
      description: Non out-of-the-box dataset used with an LLM test configuration.
      properties:
        agentGoalsColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing expected agent goals
            (For agentic workflows).
          title: agentGoalsColumnName
        correctnessEnabled:
          anyOf:
          - type: boolean
          - type: 'null'
          deprecated: true
          description: Whether correctness is enabled for the evaluation dataset configuration.
          title: correctnessEnabled
        creationDate:
          description: The creation date of the evaluation dataset configuration (ISO
            8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the evaluation dataset configuration.
          title: creationUserId
          type: string
        datasetId:
          description: The ID of the evaluation dataset.
          title: datasetId
          type: string
        datasetName:
          description: The name of the evaluation dataset.
          title: datasetName
          type: string
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the evaluation dataset configuration.
          title: errorMessage
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the evaluation dataset.
        id:
          description: The ID of the evaluation dataset configuration.
          title: id
          type: string
        name:
          description: The name of the evaluation dataset configuration.
          title: name
          type: string
        playgroundId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the playground associated with the evaluation dataset
            configuration.
          title: playgroundId
        promptColumnName:
          description: The name of the dataset column containing the prompt text.
          title: promptColumnName
          type: string
        responseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing the response text.
          title: responseColumnName
        rowsCount:
          description: The rows count of the evaluation dataset.
          title: rowsCount
          type: integer
        size:
          description: The size of the evaluation dataset (in bytes).
          title: size
          type: integer
        tenantId:
          description: The ID of the DataRobot tenant this evaluation dataset configuration
            belongs to.
          format: uuid4
          title: tenantId
          type: string
        toolCallsColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset column containing expected tool calls
            (For agentic workflows).
          title: toolCallsColumnName
        useCaseId:
          description: The ID of the use case associated with the evaluation dataset
            configuration.
          title: useCaseId
          type: string
        userName:
          description: The name of the user that created the evaluation dataset configuration.
          title: userName
          type: string
      required:
      - id
      - name
      - size
      - rowsCount
      - useCaseId
      - playgroundId
      - datasetId
      - datasetName
      - promptColumnName
      - responseColumnName
      - toolCallsColumnName
      - agentGoalsColumnName
      - userName
      - correctnessEnabled
      - creationUserId
      - creationDate
      - tenantId
      - executionStatus
      title: LLMTestConfigurationNonOOTBDatasetResponse
      type: object
    LLMTestConfigurationOOTBDatasetResponse:
      description: Out-of-the-box dataset used with an LLM test configuration.
      properties:
        datasetName:
          $ref: '#/components/schemas/OOTBDatasetName'
          description: The name of the evaluation dataset.
        datasetUrl:
          anyOf:
          - $ref: '#/components/schemas/OOTBDatasetUrl'
          - type: 'null'
          description: The public URL of the evaluation dataset. This applies only
            to our predefined public evaluation datasets.
        promptColumnName:
          description: The name of the prompt column.
          maxLength: 5000
          minLength: 1
          title: promptColumnName
          type: string
        responseColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The name of the response column, if present.
          title: responseColumnName
        rowsCount:
          description: The number rows in the dataset.
          title: rowsCount
          type: integer
        warning:
          anyOf:
          - type: string
          - type: 'null'
          description: Warning about the content of the dataset.
          title: warning
      required:
      - datasetName
      - datasetUrl
      - promptColumnName
      - responseColumnName
      - rowsCount
      title: LLMTestConfigurationOOTBDatasetResponse
      type: object
    LLMTestConfigurationResponse:
      description: API response object for a single LLMTestConfiguration.
      properties:
        creationDate:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: The creation date of the LLM Test configuration. For OOTB LLM
            Test configurations this is null.
          title: creationDate
        creationUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user who created the LLM Test configuration.
            For OOTB LLM Test configurations this is null.
          title: creationUserId
        datasetEvaluations:
          description: The LLM test dataset evaluations.
          items:
            $ref: '#/components/schemas/DatasetEvaluationResponse'
          title: datasetEvaluations
          type: array
        description:
          description: The description of the LLM Test configuration.
          title: description
          type: string
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the LLM test configuration.
          title: errorMessage
        id:
          description: The ID of the LLM Test configuration.
          title: id
          type: string
        isOutOfTheBoxTestConfiguration:
          description: Identifies the LLM Test configuration as an out-of-the-box
            (OOTB) test configuration.
          title: isOutOfTheBoxTestConfiguration
          type: boolean
        lastUpdateDate:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: The last update date of the LLM Test configuration. For OOTB
            LLM Test configurations this is null.
          title: lastUpdateDate
        lastUpdateUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user who last updated the LLM Test configuration.
            For OOTB LLM Test configurations this is null.
          title: lastUpdateUserId
        llmTestGradingCriteria:
          $ref: '#/components/schemas/LLMTestGradingCriteria'
          description: The LLM test grading criteria.
        name:
          description: The name of the LLM Test configuration.
          title: name
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, the use case ID associated with the LLM Test
            configuration.
          title: useCaseId
        warnings:
          description: Warnings for this LLM test configuration.
          items:
            additionalProperties:
              type: string
            propertyNames:
              $ref: '#/components/schemas/OOTBDatasetName'
            type: object
          title: warnings
          type: array
      required:
      - id
      - name
      - description
      - datasetEvaluations
      - llmTestGradingCriteria
      - isOutOfTheBoxTestConfiguration
      - warnings
      title: LLMTestConfigurationResponse
      type: object
    LLMTestConfigurationSupportedInsightsResponse:
      description: Response model for supported insights.
      properties:
        datasetsCompatibility:
          description: The list of insight to evaluation datasets compatibility.
          items:
            $ref: '#/components/schemas/InsightToEvalDatasetsCompatibility'
          title: datasetsCompatibility
          type: array
        supportedInsightConfigurations:
          description: The list of supported insight configurations for the LLM Tests.
          items:
            $ref: '#/components/schemas/InsightsConfigurationWithAdditionalData'
          title: supportedInsightConfigurations
          type: array
      required:
      - supportedInsightConfigurations
      - datasetsCompatibility
      title: LLMTestConfigurationSupportedInsightsResponse
      type: object
    LLMTestConfigurationType:
      description: Type of LLMTestConfiguration.
      enum:
      - ootb
      - custom
      title: LLMTestConfigurationType
      type: string
    LLMTestGradingCriteria:
      description: Grading criteria for the LLM Test configuration.
      properties:
        passThreshold:
          description: The percentage threshold for Pass results across dataset-insight
            pairs.
          maximum: 100.0
          minimum: 0.0
          title: passThreshold
          type: integer
      required:
      - passThreshold
      title: LLMTestGradingCriteria
      type: object
    LLMTestResultResponse:
      description: API response object for a single LLMTestResult.
      properties:
        creationDate:
          description: LLM test result creation date (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: ID of the user that created this LLM test result.
          title: creationUserId
          type: string
        creationUserName:
          description: The name of the user who created this LLM result.
          title: creationUserName
          type: string
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message if the LLM Test Result failed.
          title: errorMessage
        errorResolution:
          anyOf:
          - type: string
          - type: 'null'
          description: The error resolution message if the LLM Test Result failed.
          title: errorResolution
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The LLM Test execution status.
        gradingResult:
          anyOf:
          - $ref: '#/components/schemas/GradingResult'
          - type: 'null'
          description: The grading result based on the llm test grading criteria.
            If not specified, execution status is not COMPLETED.
        id:
          description: LLM test result ID.
          title: id
          type: string
        insightEvaluationResults:
          description: The Insight evaluation results.
          items:
            $ref: '#/components/schemas/InsightEvaluationResultResponse'
          title: insightEvaluationResults
          type: array
        isOutOfTheBoxTestConfiguration:
          description: Identifies the LLM Test configuration as an out-of-the-box
            (OOTB) test configuration.
          title: isOutOfTheBoxTestConfiguration
          type: boolean
        llmBlueprintId:
          description: LLM Blueprint ID.
          title: llmBlueprintId
          type: string
        llmBlueprintSnapshot:
          $ref: '#/components/schemas/LLMBlueprintSnapshot'
          description: A snapshot of the llm blueprint entity at the time of LLM Test
            execution.
        llmTestConfigurationId:
          description: LLM test configuration ID this LLM result is associated to.
          title: llmTestConfigurationId
          type: string
        llmTestConfigurationName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: Name of the LLM test configuration this LLM result is associated
            to.
          title: llmTestConfigurationName
        llmTestGradingCriteria:
          $ref: '#/components/schemas/LLMTestGradingCriteria'
          description: LLM test grading criteria.
        llmTestSuiteId:
          anyOf:
          - type: string
          - type: 'null'
          description: LLM test suite ID to which the LLM test configuration is associated
            to.
          title: llmTestSuiteId
        passPercentage:
          anyOf:
          - type: number
          - type: 'null'
          description: The percentage of underlying insight evaluation results that
            have a PASS grading result. If not specified, execution status is not
            COMPLETED.
          title: passPercentage
        useCaseId:
          description: Use case ID this LLM test result belongs to.
          title: useCaseId
          type: string
      required:
      - id
      - llmTestConfigurationId
      - llmTestConfigurationName
      - isOutOfTheBoxTestConfiguration
      - useCaseId
      - llmBlueprintId
      - llmBlueprintSnapshot
      - llmTestGradingCriteria
      - executionStatus
      - insightEvaluationResults
      - creationDate
      - creationUserId
      - creationUserName
      title: LLMTestResultResponse
      type: object
    LLMTestSuiteResponse:
      description: LLMTestSuite object formatted for API output.
      properties:
        creationDate:
          description: The creation date of the chat (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created the chat.
          title: creationUserId
          type: string
        description:
          description: The description of the LLM test suite.
          title: description
          type: string
        id:
          description: The ID of the LLM test suite.
          title: id
          type: string
        llmTestConfigurationIds:
          description: The IDs of the LLM test configurations in this LLM test suite.
          items:
            type: string
          title: llmTestConfigurationIds
          type: array
        name:
          description: The name of the LLM test suite.
          title: name
          type: string
        useCaseId:
          description: The ID of the use case associated with the LLM test suite.
          title: useCaseId
          type: string
      required:
      - id
      - name
      - description
      - useCaseId
      - llmTestConfigurationIds
      - creationDate
      - creationUserId
      title: LLMTestSuiteResponse
      type: object
    LLMType:
      description: LLM provider type.
      enum:
      - openAi
      - azureOpenAi
      title: LLMType
      type: string
    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: The model ID.
          type: string
        projectId:
          description: The 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'
        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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
        falsePositiveRate:
          description: False positive rate.
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        falsePositiveScore:
          description: False positive score.
          minimum: 0
          type:
          - integer
          - 'null'
        fractionPredictedAsNegative:
          description: Fraction of negative predictions.
          type:
          - number
          - 'null'
        fractionPredictedAsPositive:
          description: Fraction of positive predictions.
          type:
          - number
          - 'null'
        liftNegative:
          description: Negative lift.
          type:
          - number
          - 'null'
        liftPositive:
          description: Positive lift.
          type:
          - number
          - 'null'
        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
          type:
          - number
          - 'null'
        trueNegativeScore:
          description: True negative score.
          minimum: 0
          type:
          - integer
          - 'null'
        truePositiveRate:
          description: True positive rate.
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        truePositiveScore:
          description: True positive score.
          minimum: 0
          type:
          - integer
          - 'null'
      required:
      - accuracy
      - f1Score
      - falseNegativeScore
      - falsePositiveRate
      - falsePositiveScore
      - fractionPredictedAsNegative
      - fractionPredictedAsPositive
      - liftNegative
      - liftPositive
      - matthewsCorrelationCoefficient
      - negativePredictiveValue
      - positivePredictiveValue
      - threshold
      - trueNegativeRate
      - trueNegativeScore
      - truePositiveRate
      - truePositiveScore
      type: object
    Language:
      description: An enumeration.
      enum:
      - dataframe
      - markdown
      - python
      - r
      - shell
      - scala
      - sas
      - custommetric
      title: Language
      type: string
    LanguageModelDefinitionResponse:
      additionalProperties: true
      description: The metadata that defines an LLM.
      properties:
        availableLitellmEndpoints:
          $ref: '#/components/schemas/AvailableLiteLLMEndpoints'
          description: Supported endpoints for this LLM (i.e. usable LiteLLM endpoints).
            Includes supports_chat_completions and supports_responses keys.
        contextSize:
          anyOf:
          - type: integer
          - type: 'null'
          description: The size of the LLM's context, measured in tokens. `null` if
            unknown.
          title: contextSize
        creator:
          description: The company that originally created the LLM.
          title: creator
          type: string
        dateAdded:
          description: The date the LLM was added to the GenAI playground.
          format: date
          title: dateAdded
          type: string
        description:
          description: The details about the LLM.
          title: description
          type: string
        documentationLink:
          anyOf:
          - type: string
          - type: 'null'
          description: The link to the vendor documentation for the LLM.
          title: documentationLink
        id:
          description: The ID of the LLM.
          title: id
          type: string
        isActive:
          description: Whether the LLM is active.
          title: isActive
          type: boolean
        isDeprecated:
          description: Whether the LLM is deprecated and will be removed in a future
            release.
          title: isDeprecated
          type: boolean
        isMetered:
          default: true
          description: Whether the LLM usage is metered.
          title: isMetered
          type: boolean
        isSupportedForModeration:
          description: Whether the LLM is supported for moderation.
          title: isSupportedForModeration
          type: boolean
        license:
          description: The usage license information for the LLM.
          title: license
          type: string
        name:
          description: The name of the LLM.
          title: name
          type: string
        provider:
          description: The party that provides access to the LLM.
          title: provider
          type: string
        referenceLinks:
          description: The references for the LLM.
          items:
            $ref: '#/components/schemas/LLMReference'
          title: referenceLinks
          type: array
        retirementDate:
          anyOf:
          - format: date
            type: string
          - type: 'null'
          description: When the LLM is expected to be retired and no longer available
            for submitting new prompts.
          title: retirementDate
        settings:
          description: The settings supported by the LLM.
          items:
            $ref: '#/components/schemas/LLMSettingDefinition'
          title: settings
          type: array
        suggestedReplacement:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM suggested as a replacement for this one when
            it is retired.
          title: suggestedReplacement
        supportedCustomModelLLMValidations:
          anyOf:
          - items:
              $ref: '#/components/schemas/SupportedCustomModelLLMValidation'
            type: array
          - type: 'null'
          description: The supported custom model validations if applicable for this
            LLM ID.
          title: supportedCustomModelLLMValidations
        supportedLanguages:
          description: The languages supported by the LLM.
          title: supportedLanguages
          type: string
        vendor:
          description: The vendor of the LLM.
          title: vendor
          type: string
      required:
      - id
      - name
      - description
      - vendor
      - provider
      - creator
      - license
      - supportedLanguages
      - settings
      - documentationLink
      - referenceLinks
      - dateAdded
      - isDeprecated
      - isActive
      - isSupportedForModeration
      - availableLitellmEndpoints
      title: LanguageModelDefinitionResponse
      type: object
    LifecycleStrategiesDataModel:
      description: Lifecycle strategy configuration that defines when and how to manage
        session lifecycle.
      example:
        trigger:
          ttl: 86400
        type: soft_delete
      properties:
        opts:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Optional strategy-specific configuration parameters
          title: Opts
        trigger:
          anyOf:
          - $ref: '#/components/schemas/TTLTrigger'
          - $ref: '#/components/schemas/EventCountTrigger'
          - $ref: '#/components/schemas/TokenCountTrigger'
          - $ref: '#/components/schemas/IdleTimeoutTrigger'
          description: 'Trigger condition. Available: ''ttl'' (time in seconds), ''eventCount'',
            ''tokenCount'', ''idle'''
          title: Trigger
        type:
          description: 'Strategy type. Available: ''soft_delete'''
          enum:
          - soft_delete
          - extract_memories
          title: Type
          type: string
      required:
      - type
      - trigger
      title: LifecycleStrategiesDataModel
      type: object
    LifecycleStrategyResponse:
      description: 'Schema for lifecycle strategy in response.


        Execution status is tracked in the strategy_executions table and can be

        queried separately if needed.'
      properties:
        opts:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Strategy-specific configuration parameters.
          title: Opts
        trigger:
          anyOf:
          - $ref: '#/components/schemas/TTLTrigger'
          - $ref: '#/components/schemas/EventCountTrigger'
          - $ref: '#/components/schemas/TokenCountTrigger'
          - $ref: '#/components/schemas/IdleTimeoutTrigger'
          description: Trigger condition.
          title: Trigger
        type:
          description: Strategy type.
          enum:
          - soft_delete
          - extract_memories
          title: Type
          type: string
      required:
      - type
      - trigger
      title: LifecycleStrategyResponse
      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: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    LiftChartResponse:
      description: Lift chart data.
      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 the dataset that was used to compute the
            lift chart.
          type: string
      required:
      - bins
      - datasetId
      type: object
    LimitDirectiveArguments:
      description: The interactive sampling config.
      properties:
        rows:
          default: 1000
          description: The number of rows to be selected.
          maximum: 10000
          minimum: 1
          type: integer
          x-versionadded: v2.33
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - rows
      - skip
      type: object
    LimitInfo:
      description: A limitInfo object for prepaid deployment information.
      properties:
        limitReached:
          description: Whether the limit named has been reached.
          type: boolean
        reason:
          description: The reason why the limit has been reached.
          type:
          - string
          - 'null'
          x-versionadded: v2.43
        value:
          description: The limit value of the given limit.
          type: integer
      required:
      - limitReached
      - reason
      - value
      type: object
      x-versionadded: v2.43
    Link:
      properties:
        fileName:
          description: 'The name of the file associated with the generated link. '
          type:
          - string
          - 'null'
        url:
          description: 'The generated link associated with the requested file. '
          type: string
      required:
      - fileName
      - url
      type: object
      x-versionadded: v2.37
    LinkView:
      description: The link object.
      properties:
        attributes:
          additionalProperties:
            type: string
          description: The attributes of the link.
          type: object
        spanId:
          description: The span ID.
          maxLength: 32
          minLength: 16
          type: string
        traceId:
          description: The OTel trace ID.
          maxLength: 32
          minLength: 16
          type: string
      required:
      - attributes
      - spanId
      - traceId
      type: object
      x-versionadded: v2.37
    ListChatPromptsResponse:
      description: Paginated list of chat prompts.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ChatPromptResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListChatPromptsResponse
      type: object
    ListChatsResponse:
      description: Paginated list of chats.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ChatResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListChatsResponse
      type: object
    ListCodeSnippetsResponse:
      description: Response schema for the list of code snippets.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: A list of code snippets.
          items:
            $ref: '#/components/schemas/CodeSnippet'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: ListCodeSnippetsResponse
      type: object
    ListCodeSnippetsTagsResponse:
      description: Response schema for the list of code snippets tags.
      properties:
        tags:
          description: A list of tags for the code snippets.
          items:
            type: string
          title: Tags
          type: array
      title: ListCodeSnippetsTagsResponse
      type: object
    ListComparisonChatsResponse:
      description: Paginated list of comparison chats.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ComparisonChatResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListComparisonChatsResponse
      type: object
    ListComparisonPromptsResponse:
      description: Paginated list of comparison prompts.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ComparisonPromptResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListComparisonPromptsResponse
      type: object
    ListCredentialsAssociationsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of credentials associations.
          items:
            $ref: '#/components/schemas/RetrieveCredentialAssociationResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ListCustomModelEmbeddingValidationResponse:
      description: Paginated list of custom model embedding validations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/CustomModelEmbeddingValidationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListCustomModelEmbeddingValidationResponse
      type: object
    ListCustomModelLLMValidationsResponse:
      description: Paginated list of custom model LLM validations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/CustomModelLLMValidationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListCustomModelLLMValidationsResponse
      type: object
    ListCustomModelValidationSortQueryParam:
      description: Sort order values for listing custom model validations.
      enum:
      - name
      - -name
      - deploymentName
      - -deploymentName
      - userName
      - -userName
      - creationDate
      - -creationDate
      title: ListCustomModelValidationSortQueryParam
      type: string
    ListCustomModelVectorDatabaseValidationsResponse:
      description: Paginated list of custom model vector database validations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/CustomModelVectorDatabaseValidationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListCustomModelVectorDatabaseValidationsResponse
      type: object
    ListDataFrameResponse:
      description: Schema for the list of DataFrames in a notebook.
      properties:
        dataframes:
          description: List of DataFrames information.
          items:
            $ref: '#/components/schemas/DataFrameEntrySchema'
          title: Dataframes
          type: array
      title: ListDataFrameResponse
      type: object
    ListDataframesResponse:
      description: Response schema for listing DataFrames in a notebook session.
      properties:
        dataframes:
          description: List of DataFrames in the notebook session.
          items:
            $ref: '#/components/schemas/InteractiveVariablesSchema'
          title: Dataframes
          type: array
      title: ListDataframesResponse
      type: object
    ListEvaluationDatasetConfigurationResponse:
      description: Paginated list of evaludation dataset configurations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/EvaluationDatasetConfigurationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListEvaluationDatasetConfigurationResponse
      type: object
    ListEvaluationDatasetConfigurationsQueryParam:
      description: Sort order values for listing evaluation dataset configurations.
      enum:
      - name
      - -name
      - creationUserId
      - -creationUserId
      - creationDate
      - -creationDate
      - datasetId
      - -datasetId
      - userName
      - -userName
      - datasetName
      - -datasetName
      - promptColumnName
      - -promptColumnName
      - responseColumnName
      - -responseColumnName
      title: ListEvaluationDatasetConfigurationsQueryParam
      type: string
    ListEvaluationDatasetMetricAggregationAggregatedByLLMBlueprintResponse:
      description: Paginated list of evaluation dataset metric aggregations, aggregated
        by LLM blueprint.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/EvaluationDatasetMetricAggregationAggregatedByLLMBlueprintResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListEvaluationDatasetMetricAggregationAggregatedByLLMBlueprintResponse
      type: object
    ListEvaluationDatasetMetricAggregationResponse:
      description: Paginated list of evaluation dataset metric aggregations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/EvaluationDatasetMetricAggregationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListEvaluationDatasetMetricAggregationResponse
      type: object
    ListEvaluationDatasetMetricAggregationSortQueryParam:
      description: Sort order values for listing evaluation dataset metric aggregations.
      enum:
      - metricName
      - -metricName
      - aggregationValue
      - -aggregationValue
      - datasetName
      - -datasetName
      - datasetId
      - -datasetId
      - creationUserId
      - -creationUserId
      - creationUserName
      - -creationUserName
      - creationDate
      - -creationDate
      - evaluationDatasetConfigurationId
      - -evaluationDatasetConfigurationId
      title: ListEvaluationDatasetMetricAggregationSortQueryParam
      type: string
    ListEvaluationDatasetMetricAggregationUniqueFieldValuesResponse:
      description: Paginated list of evaluation dataset metric aggregations with unique
        computed metrics.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/EvaluationDatasetMetricAggregationUniqueFieldValuesResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListEvaluationDatasetMetricAggregationUniqueFieldValuesResponse
      type: object
    ListFilesystemObjectsRequest:
      description: We have set the limit max value to one thousand
      properties:
        limit:
          default: 100
          description: Maximum number of objects to return.
          exclusiveMinimum: 0.0
          maximum: 1000.0
          title: Limit
          type: integer
        offset:
          default: 0
          description: Offset for pagination.
          minimum: 0.0
          title: Offset
          type: integer
        path:
          description: Path to the filesystem object.
          title: Path
          type: string
        sortBy:
          allOf:
          - $ref: '#/components/schemas/FilesystemSortBy'
          default: name
          description: Sort results by this field.
      required:
      - path
      title: ListFilesystemObjectsRequest
      type: object
    ListFilesystemObjectsResponse:
      description: Response schema for listing filesystem objects.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of filesystem objects.
          items:
            $ref: '#/components/schemas/FilesystemObjectSchema'
          title: Data
          type: array
        datarobotMetadata:
          additionalProperties:
            $ref: '#/components/schemas/DRFileMetadata'
          description: Metadata for DataRobot files.
          title: Datarobotmetadata
          type: object
        directoryHierarchy:
          description: List of directories respective names and paths.
          items:
            $ref: '#/components/schemas/DirHierarchyObjectSchema'
          title: Directoryhierarchy
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      required:
      - data
      - directoryHierarchy
      - datarobotMetadata
      title: ListFilesystemObjectsResponse
      type: object
    ListGitProvidersResponse:
      description: A list of authorized Git OAuth providers available for the user.
      properties:
        providers:
          description: A list of authorized Git OAuth providers.
          items:
            $ref: '#/components/schemas/GitProviderSchema'
          maxItems: 1000
          minItems: 0
          title: Providers
          type: array
      required:
      - providers
      title: ListGitProvidersResponse
      type: object
    ListGitRepositoriesResponse:
      description: 'A list of Git repositories available for the authorized Git provider
        and the related params used for filtering

        (if provided).'
      properties:
        data:
          description: A list of Git repositories.
          items:
            $ref: '#/components/schemas/GitRepositorySchema'
          title: Data
          type: array
        params:
          additionalProperties:
            type: string
          description: The params used when listing Git repositories.
          title: Params
          type: object
      required:
      - data
      title: ListGitRepositoriesResponse
      type: object
    ListGitRepositoryQuery:
      description: The possible query params to use when listing git repositories.
      properties:
        limit:
          default: 30
          description: The number of repositories to return.
          exclusiveMinimum: 1.0
          maximum: 100.0
          title: Limit
          type: integer
        query:
          description: A search query for repository names.
          title: Query
          type: string
      title: ListGitRepositoryQuery
      type: object
    ListLLMBlueprintSortQueryParam:
      description: Sort order values for listing LLM blueprints.
      enum:
      - name
      - -name
      - description
      - -description
      - creationUserId
      - -creationUserId
      - creationDate
      - -creationDate
      - lastUpdateUserId
      - -lastUpdateUserId
      - lastUpdateDate
      - -lastUpdateDate
      - llmId
      - -llmId
      - vectorDatabaseId
      - -vectorDatabaseId
      title: ListLLMBlueprintSortQueryParam
      type: string
    ListLLMBlueprintsResponse:
      description: Paginated list of LLM blueprints.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LLMBlueprintResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMBlueprintsResponse
      type: object
    ListLLMTestConfigurationNonOOTBDatasetsResponse:
      description: Paginated list of non-OOTB datasets for use with LLM test configurations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LLMTestConfigurationNonOOTBDatasetResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMTestConfigurationNonOOTBDatasetsResponse
      type: object
    ListLLMTestConfigurationOOTBDatasetsResponse:
      description: Paginated list of OOTB datasets for use with LLM test configurations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LLMTestConfigurationOOTBDatasetResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMTestConfigurationOOTBDatasetsResponse
      type: object
    ListLLMTestConfigurationsResponse:
      description: Paginated list of LLM test configurations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LLMTestConfigurationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMTestConfigurationsResponse
      type: object
    ListLLMTestResultResponse:
      description: Paginated list of LLM test results.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LLMTestResultResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMTestResultResponse
      type: object
    ListLLMTestSuiteSortQueryParam:
      description: Sort order values for listing chats.
      enum:
      - name
      - -name
      - creationDate
      - -creationDate
      title: ListLLMTestSuiteSortQueryParam
      type: string
    ListLLMTestSuitesResponse:
      description: Paginated list of LLM test suites.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LLMTestSuiteResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMTestSuitesResponse
      type: object
    ListLLMsResponse:
      description: Paginated list of LLMs.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/LanguageModelDefinitionResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListLLMsResponse
      type: object
    ListNotebookRevisionsQuerySchema:
      description: Query schema for listing notebook revisions.
      properties:
        autosaved:
          description: Whether to include autosaved revisions.
          title: Autosaved
          type: boolean
        createdAfter:
          description: Filter revisions created after this date.
          format: date-time
          title: Createdafter
          type: string
        limit:
          default: 10
          description: The limit or results to return.
          exclusiveMinimum: 0.0
          maximum: 100.0
          title: Limit
          type: integer
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
        orderBy:
          allOf:
          - $ref: '#/components/schemas/OrderBy'
          default: created
          description: Order by field.
      title: ListNotebookRevisionsQuerySchema
      type: object
    ListNotebookRevisionsResponse:
      description: Response schema for listing notebook revisions.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of notebook revisions.
          items:
            $ref: '#/components/schemas/NotebookRevisionSchema'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: ListNotebookRevisionsResponse
      type: object
    ListNotebooksQuery:
      description: Query options for listing notebooks in the notebooks directory.
      properties:
        allUseCases:
          default: false
          description: Whether to include all Use Cases.
          title: Allusecases
          type: boolean
        createdAfter:
          description: Filter notebooks created after this date.
          format: date-time
          title: Createdafter
          type: string
        createdBefore:
          description: Filter notebooks created before this date.
          format: date-time
          title: Createdbefore
          type: string
        limit:
          default: 10
          description: The maximum number of notebooks to return.
          exclusiveMinimum: 0.0
          maximum: 1000.0
          title: Limit
          type: integer
        name:
          default: ''
          description: A name to filter notebooks by.
          title: Name
          type: string
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
        orderBy:
          allOf:
          - $ref: '#/components/schemas/OrderBy'
          default: -updated
          description: The order in which to sort the notebooks.
        owners:
          description: A list of user IDs to filter notebooks by.
          items:
            type: string
          title: Owners
          type: array
        query:
          description: A query to filter notebooks by name and description.
          title: Query
          type: string
        tags:
          description: A list of tags to filter notebooks by.
          items:
            type: string
          title: Tags
          type: array
        type:
          description: The notebook type to filter by.
          items:
            $ref: '#/components/schemas/NotebookType'
          type: array
        types:
          description: The notebook type to filter by.
          items:
            $ref: '#/components/schemas/NotebookType'
          type: array
        useCaseId:
          description: The ID of a Use Case to filter notebooks by.
          title: Usecaseid
          type: string
      title: ListNotebooksQuery
      type: object
    ListNotebooksResponse:
      description: Response schema for listing notebooks.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: A list of notebooks.
          items:
            $ref: '#/components/schemas/NotebookSchema'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: ListNotebooksResponse
      type: object
    ListParameterConstraints:
      description: Available constraints for list parameters.
      properties:
        elementConstraints:
          anyOf:
          - $ref: '#/components/schemas/IntegerSettingConstraints'
          - $ref: '#/components/schemas/FloatSettingConstraints'
          - $ref: '#/components/schemas/StringSettingConstraints'
          - $ref: '#/components/schemas/BooleanSettingConstraints'
          - $ref: '#/components/schemas/ObjectIdSettingConstraints'
          - type: 'null'
          description: Constraints to apply to each element.
          title: elementConstraints
        elementType:
          $ref: '#/components/schemas/SettingType'
          description: The type of elements in the list.
        maxLength:
          anyOf:
          - type: integer
          - type: 'null'
          description: The maximum length of the list (inclusive).
          title: maxLength
        minLength:
          anyOf:
          - type: integer
          - type: 'null'
          description: The minimum length of the list (inclusive).
          title: minLength
        type:
          const: list
          default: list
          description: The data type of the parameter.
          title: type
          type: string
      required:
      - elementType
      title: ListParameterConstraints
      type: object
    ListPlaygroundSortQueryParam:
      description: Sort order values for listing playgrounds.
      enum:
      - name
      - -name
      - description
      - -description
      - creationUserId
      - -creationUserId
      - creationDate
      - -creationDate
      - lastUpdateUserId
      - -lastUpdateUserId
      - lastUpdateDate
      - -lastUpdateDate
      - savedLLMBlueprintsCount
      - -savedLLMBlueprintsCount
      - llmBlueprintsCount
      - -llmBlueprintsCount
      title: ListPlaygroundSortQueryParam
      type: string
    ListPlaygroundsResponse:
      description: Paginated list of playgrounds.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/PlaygroundResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListPlaygroundsResponse
      type: object
    ListPromptTemplateVersionsResponse:
      description: Paginated list of prompt template versions.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/PromptTemplateVersionResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListPromptTemplateVersionsResponse
      type: object
    ListPromptTemplatesResponse:
      description: Paginated list of prompt templates.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/PromptTemplateResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListPromptTemplatesResponse
      type: object
    ListScheduledJobQuery:
      description: Query parameters for listing scheduled jobs.
      properties:
        createdByIds:
          description: The IDs of the users who created the scheduled jobs.
          items:
            type: string
          title: Createdbyids
          type: array
        lastRunEnd:
          description: The end time of the last run to filter the scheduled jobs by.
          format: date-time
          title: Lastrunend
          type: string
        lastRunStart:
          description: The start time of the last run to filter the scheduled jobs
            by.
          format: date-time
          title: Lastrunstart
          type: string
        limit:
          default: 10
          description: The limit or results to return.
          exclusiveMinimum: 0.0
          maximum: 100.0
          title: Limit
          type: integer
        nextRunEnd:
          description: The end time of the next run to filter the scheduled jobs by.
          format: date-time
          title: Nextrunend
          type: string
        nextRunStart:
          description: The start time of the next run to filter the scheduled jobs
            by.
          format: date-time
          title: Nextrunstart
          type: string
        notebookIds:
          description: The IDs of the notebooks to filter the scheduled jobs by.
          items:
            type: string
          title: Notebookids
          type: array
        notebookTypes:
          description: The types of notebooks to filter the scheduled jobs by.
          items:
            $ref: '#/components/schemas/NotebookType'
          type: array
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
        orderBy:
          allOf:
          - $ref: '#/components/schemas/ScheduledJobListOrderBy'
          description: The field to order the results by.
        search:
          description: The search term to filter the scheduled jobs.
          title: Search
          type: string
        statuses:
          description: The statuses to filter the scheduled jobs by.
          items:
            enum:
            - enabled
            - disabled
            type: string
          title: Statuses
          type: array
        titles:
          description: The titles to filter the scheduled jobs by.
          items:
            type: string
          title: Titles
          type: array
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      title: ListScheduledJobQuery
      type: object
    ListScheduledRunsHistoryQuery:
      description: Query parameters for listing scheduled runs history.
      properties:
        createdByIds:
          description: The IDs of the users who created the scheduled runs history.
          items:
            type: string
          title: Createdbyids
          type: array
        endTimeEnd:
          description: The end time of the run to filter the scheduled runs history
            by.
          format: date-time
          title: Endtimeend
          type: string
        endTimeStart:
          description: The start time of the run to filter the scheduled runs history
            by.
          format: date-time
          title: Endtimestart
          type: string
        envIds:
          description: The IDs of the environments to filter the scheduled runs history
            by.
          items:
            type: string
          title: Envids
          type: array
        jobIds:
          description: The IDs of the jobs to filter the scheduled runs history by.
          items:
            type: string
          title: Jobids
          type: array
        limit:
          default: 10
          description: The limit or results to return.
          exclusiveMinimum: 0.0
          maximum: 100.0
          title: Limit
          type: integer
        notebookIds:
          description: The IDs of the notebooks to filter the scheduled runs history
            by.
          items:
            type: string
          title: Notebookids
          type: array
        notebookTypes:
          description: The types of notebooks to filter the scheduled runs history
            by.
          items:
            $ref: '#/components/schemas/NotebookType'
          type: array
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
        orderBy:
          allOf:
          - $ref: '#/components/schemas/ScheduledHistoryListOrderBy'
          default: -created
          description: The field to order the results by.
        runTypes:
          description: The types of runs to filter the scheduled runs history by.
          items:
            $ref: '#/components/schemas/RunTypes'
          type: array
        search:
          description: The search term to filter the scheduled runs history.
          title: Search
          type: string
        startTimeEnd:
          description: The end time of the run to filter the scheduled runs history
            by.
          format: date-time
          title: Starttimeend
          type: string
        startTimeStart:
          description: The start time of the run to filter the scheduled runs history
            by.
          format: date-time
          title: Starttimestart
          type: string
        statuses:
          description: The statuses to filter the scheduled runs history by.
          items:
            type: string
          title: Statuses
          type: array
        titles:
          description: The titles to filter the scheduled runs history by.
          items:
            type: string
          title: Titles
          type: array
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      title: ListScheduledRunsHistoryQuery
      type: object
    ListSearchStudyResponse:
      description: Paginated list of search studies.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/SearchStudyResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListSearchStudyResponse
      type: object
    ListSearchStudySortQueryParam:
      description: API object for Sort order values for listiing search studies.
      enum:
      - name
      - -name
      title: ListSearchStudySortQueryParam
      type: string
    ListSidecarModelMetricValidationnResponse:
      description: Paginated list of sidecar model metric validations.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/SidecarModelMetricValidationResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListSidecarModelMetricValidationnResponse
      type: object
    ListSnippetsQuerySchema:
      description: Query schema for searching code nuggets.
      properties:
        language:
          description: The programming language of the code snippet to query for.
          title: Language
          type: string
        languageVersion:
          description: The programming language version of the code snippet to query
            for.
          title: Languageversion
          type: string
        limit:
          default: 10
          description: The limit or results to return.
          exclusiveMinimum: 0.0
          maximum: 100.0
          title: Limit
          type: integer
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
        q:
          description: A search query to filter the code snippets.
          title: Q
          type: string
        tags:
          description: A comma separated list of tags to filter the code snippets.
          title: Tags
          type: string
      title: ListSnippetsQuerySchema
      type: object
    ListSsoConfigurationResponse:
      properties:
        count:
          description: Number of SSO configurations returned.
          minimum: 0
          type: integer
        data:
          description: SSO configuration.
          items:
            $ref: '#/components/schemas/EnhancedSsoConfigurationResponse'
          maxItems: 1000
          type: array
        next:
          description: Link to the next page of the SSO configurations.
          type:
          - string
          - 'null'
        previous:
          description: Link to the previous page of the SSO configurations.
          type:
          - string
          - 'null'
        totalCount:
          description: Total number of SSO configurations.
          minimum: 0
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ListTracesResponse:
      description: Paginated list of playground prompt traces.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/PromptTraceResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListTracesResponse
      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'
          maxItems: 1000
          type: array
        next:
          description: The URL to the next page.
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL to the previous page.
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items that match the query condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ListVectorDatabaseSortQueryParam:
      description: Sort order values for listing vector databases.
      enum:
      - name
      - -name
      - creationUserId
      - -creationUserId
      - creationDate
      - -creationDate
      - embeddingModel
      - -embeddingModel
      - datasetId
      - -datasetId
      - chunkingMethod
      - -chunkingMethod
      - chunksCount
      - -chunksCount
      - size
      - -size
      - userName
      - -userName
      - datasetName
      - -datasetName
      - playgroundsCount
      - -playgroundsCount
      - source
      - -source
      title: ListVectorDatabaseSortQueryParam
      type: string
    ListVectorDatabasesResponse:
      description: Paginated list of vector databases.
      properties:
        count:
          description: The number of records on this page.
          title: count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/VectorDatabaseResponse'
          title: data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: previous
        totalCount:
          description: The total number of records.
          title: totalCount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ListVectorDatabasesResponse
      type: object
    LocalFileDataStreamer:
      description: Stream CSV data chunks from local file storage
      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.'
          type:
          - boolean
          - 'null'
          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:
      description: Stream CSV data chunks from local file storage
      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.'
          type:
          - boolean
          - 'null'
          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:
      description: Save CSV data chunks to local file storage
      properties:
        type:
          description: Type name for this output type
          enum:
          - local_file
          - localFile
          type: string
      required:
      - type
      type: object
    LocalFileOutputAdaptor:
      description: Save CSV data chunks to local file storage
      properties:
        type:
          description: Type name for this output type
          enum:
          - local_file
          - localFile
          type: string
      required:
      - type
      type: object
    MCPServerDeploymentPrompt:
      properties:
        createdAt:
          description: Datetime when this record is added. It is formated as RFC3339
            UTC, e.g. 2026-02-24T19:12:48.285320Z
          type: string
        id:
          description: Id of prompt record associated with one user MCP server deployment
          type: string
        mcpServerDeploymentId:
          description: User MCP server deployment id (custom model deployment id)
          type: string
        name:
          description: MCP prompt name
          maxLength: 256
          type: string
        type:
          description: Supported MCP prompt types
          enum:
          - userPromptTemplate
          - userPromptTemplateVersion
          type: string
        userId:
          description: Id of user who owns MCP server deployment
          type: string
        userName:
          description: Name of user who owns MCP server deployment
          type: string
      required:
      - createdAt
      - id
      - mcpServerDeploymentId
      - name
      - type
      - userId
      - userName
      type: object
      x-versionadded: v2.46
    MCPServerDeploymentResource:
      properties:
        createdAt:
          description: Datetime when this record is added. It is formated as RFC3339
            UTC, e.g. 2026-02-24T19:12:48.285320Z
          type: string
        id:
          description: Id of resource record associated with one user MCP server deployment
          type: string
        mcpServerDeploymentId:
          description: User MCP server deployment id (custom model deployment id)
          type: string
        name:
          description: MCP resource name
          maxLength: 256
          type: string
        type:
          description: Supported MCP resource types
          enum:
          - userResource
          type: string
        uri:
          description: MCP resource URI
          type: string
        userId:
          description: Id of user who owns MCP server deployment
          type: string
        userName:
          description: Name of user who owns MCP server deployment
          type: string
      required:
      - createdAt
      - id
      - mcpServerDeploymentId
      - name
      - type
      - uri
      - userId
      - userName
      type: object
      x-versionadded: v2.46
    MCPServerDeploymentTool:
      properties:
        createdAt:
          description: Datetime when this record is added. It is formated as RFC3339
            UTC, e.g. 2026-02-24T19:12:48.285320Z
          type: string
        id:
          description: Id of tool record associated with one user MCP server deployment
          type: string
        mcpServerDeploymentId:
          description: User MCP server deployment id (custom model deployment id)
          type: string
        name:
          description: MCP tool name
          maxLength: 256
          type: string
        type:
          description: Supported MCP tool types
          enum:
          - userTool
          - builtInTool
          - userToolDeployment
          type: string
        userId:
          description: Id of user who owns MCP server deployment
          type: string
        userName:
          description: Name of user who owns MCP server deployment
          type: string
      required:
      - createdAt
      - id
      - mcpServerDeploymentId
      - name
      - type
      - userId
      - userName
      type: object
      x-versionadded: v2.46
    MCPServerVersionPrompt:
      properties:
        createdAt:
          description: The datetime when this record was added. It is formatted as
            RFC3339 UTC (e.g., 2026-02-24T19:12:48.285320Z).
          type: string
        id:
          description: The user MCP server version prompt record ID.
          type: string
        mcpServerVersionId:
          description: The user MCP server version ID (custom model version ID).
          type: string
        name:
          description: The MCP prompt name.
          maxLength: 256
          type: string
        type:
          description: Supported MCP onboard prompt types
          enum:
          - userPromptTemplate
          type: string
        userId:
          description: The ID of the user who owns the MCP server version.
          type: string
        userName:
          description: The name of the user who owns the MCP server version.
          type: string
      required:
      - createdAt
      - id
      - mcpServerVersionId
      - name
      - type
      - userId
      - userName
      type: object
      x-versionadded: v2.46
    MCPServerVersionResource:
      properties:
        createdAt:
          description: The datetime when this record was added. It is formatted as
            RFC3339 UTC (e.g., 2026-02-24T19:12:48.285320Z).
          type: string
        id:
          description: The user MCP server version resource record ID.
          type: string
        mcpServerVersionId:
          description: The user MCP server version ID (custom model version ID).
          type: string
        name:
          description: The MCP resource name.
          maxLength: 256
          type: string
        type:
          description: Supported MCP onboard resource types
          enum:
          - userResource
          type: string
        uri:
          description: The MCP resource URI.
          type: string
        userId:
          description: The ID of the user who owns the MCP server version.
          type: string
        userName:
          description: The name of the user who owns the MCP server version.
          type: string
      required:
      - createdAt
      - id
      - mcpServerVersionId
      - name
      - type
      - uri
      - userId
      - userName
      type: object
      x-versionadded: v2.46
    MCPServerVersionTool:
      properties:
        createdAt:
          description: The datetime when this record was added. It is formatted as
            RFC3339 UTC (e.g., 2026-02-24T19:12:48.285320Z).
          type: string
        id:
          description: The user MCP server version tool record ID.
          type: string
        mcpServerVersionId:
          description: The user MCP server version ID (custom model version ID).
          type: string
        name:
          description: The MCP tool name.
          maxLength: 256
          type: string
        type:
          description: Supported MCP onboard tool types
          enum:
          - userTool
          - builtInTool
          type: string
        userId:
          description: The ID of the user who owns the MCP server version.
          type: string
        userName:
          description: The name of the user who owns the MCP server version.
          type: string
      required:
      - createdAt
      - id
      - mcpServerVersionId
      - name
      - type
      - userId
      - userName
      type: object
      x-versionadded: v2.46
    Machine:
      description: Machine is a class that represents a machine type in the system.
      properties:
        bundleId:
          description: Bundle ID.
          title: Bundleid
          type: string
        cpu:
          description: Number of CPU cores. Can be in millicores (e.g., 1000m) or
            cores (e.g. ,1).
          title: Cpu
          type: string
        cpuCores:
          default: 0
          description: CPU cores.
          title: Cpucores
          type: number
        default:
          default: false
          description: Is this machine type default for the environment.
          title: Default
          type: boolean
        ephemeralStorage:
          default: 10Gi
          description: Ephemeral storage size.
          title: Ephemeralstorage
          type: string
        gpu:
          description: GPU cores.
          title: Gpu
          type: string
        hasGpu:
          default: false
          description: Whether or not this machine type has a GPU.
          title: Hasgpu
          type: boolean
        id:
          description: Machine ID.
          title: Id
          type: string
        memory:
          description: Memory size. Can be in GiB (e.g., 4Gi) or bytes (e.g., 4G).
          title: Memory
          type: string
        name:
          description: Machine name.
          title: Name
          type: string
        ramGb:
          default: 0
          description: RAM in GB.
          title: Ramgb
          type: integer
      required:
      - id
      - name
      title: Machine
      type: object
    MachineStatuses:
      description: This enum represents possible overall state of the machine(s) of
        all components of the notebook.
      enum:
      - not_started
      - allocated
      - starting
      - running
      - restarting
      - stopping
      - stopped
      - dead
      - deleted
      title: MachineStatuses
      type: string
    MachinesPublic:
      description: Represents a list of machine types in the system.
      properties:
        machines:
          description: List of machine types.
          items:
            $ref: '#/components/schemas/Machine'
          title: Machines
          type: array
      title: MachinesPublic
      type: object
    ManualRunTypes:
      description: Intentionally a subset of RunTypes above - to be used in API schemas
      enum:
      - manual
      - pipeline
      title: ManualRunTypes
      type: string
    MarkdownCellSchema:
      description: The schema for a markdown cell in the notebook.
      properties:
        attachments:
          description: Attachments of the cell.
          title: Attachments
          type: object
        cellType:
          allOf:
          - $ref: '#/components/schemas/SupportedCellTypes'
          default: markdown
          description: Type of the cell.
        id:
          description: ID of the cell.
          title: Id
          type: string
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: Metadata of the cell.
          title: Metadata
        source:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          default: ''
          description: Contents of the cell, represented as a string.
          title: Source
      required:
      - id
      title: MarkdownCellSchema
      type: object
    MaterializationDestination:
      description: Destination table information to create and materialize the recipe
        to. If None, the recipe will be materialized in DataRobot.
      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
    MemoryCreate:
      description: "Request body for POST /v1/memories \u2014 extracts facts from\
        \ a conversation"
      properties:
        agentId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Agentid
        appId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Appid
        expirationDate:
          anyOf:
          - maxLength: 40
            type: string
          - type: 'null'
          title: Expirationdate
        infer:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Infer
        messages:
          items:
            $ref: '#/components/schemas/Message'
          maxItems: 100
          minItems: 1
          title: Messages
          type: array
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
        runId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Runid
        userId:
          maxLength: 64
          minLength: 1
          title: Userid
          type: string
      required:
      - userId
      - messages
      title: MemoryCreate
      type: object
    MemoryGetAll:
      description: 'Request body for POST /v2/memories


        extra="ignore" is set because the mem0 client injects org_id/project_id

        fields that are not relevant for DataRobot.'
      properties:
        agentId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Agentid
        appId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Appid
        filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filters
        pageSize:
          anyOf:
          - maximum: 50.0
            minimum: 1.0
            type: integer
          - type: 'null'
          title: Pagesize
        runId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Runid
        topK:
          anyOf:
          - maximum: 50.0
            minimum: 1.0
            type: integer
          - type: 'null'
          title: Topk
        userId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Userid
      title: MemoryGetAll
      type: object
    MemorySearch:
      description: 'Request body for POST /v2/memories/search/


        extra="ignore" is set because the mem0 client injects org_id/project_id

        fields that are not relevant for DataRobot.'
      properties:
        agentId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Agentid
        appId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Appid
        filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Filters
        query:
          maxLength: 2000
          minLength: 1
          title: Query
          type: string
        rerank:
          default: true
          title: Rerank
          type: boolean
        runId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Runid
        threshold:
          anyOf:
          - type: number
          - type: 'null'
          title: Threshold
        topK:
          anyOf:
          - maximum: 50.0
            minimum: 1.0
            type: integer
          - type: 'null'
          title: Topk
        userId:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Userid
      required:
      - query
      title: MemorySearch
      type: object
    MemorySpaceResponse:
      description: Response schema for a single Memory Space
      properties:
        createdAt:
          description: Memory space creation timestamp.
          format: date-time
          title: Createdat
          type: string
        customInstructions:
          anyOf:
          - type: string
          - type: 'null'
          description: Custom prompt instructions used for fact extraction. Null means
            the default mem0 extraction prompt is used.
          title: Custominstructions
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Memory space description.
          title: Description
        llmBaseUrl:
          anyOf:
          - format: uri
            maxLength: 2083
            minLength: 1
            type: string
          - type: 'null'
          description: Chat API URL to use for memory extraction.
          title: Llmbaseurl
        llmModelName:
          anyOf:
          - type: string
          - type: 'null'
          description: LLM model configured for memory extraction.
          title: Llmmodelname
        memorySpaceId:
          description: Unique memory space identifier.
          format: uuid
          title: Memoryspaceid
          type: string
        tenantId:
          description: Tenant identifier.
          format: uuid
          title: Tenantid
          type: string
        userId:
          description: ID of the user who owns this memory space.
          title: Userid
          type: string
      required:
      - memorySpaceId
      - userId
      - tenantId
      - createdAt
      title: MemorySpaceResponse
      type: object
    MemoryUpdate:
      description: 'Request body for PUT /v1/memories/{memory_id}.


        metadata and timestamp are accepted for mem0 client compatibility but not
        forwarded.'
      properties:
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata
        text:
          maxLength: 10000
          minLength: 1
          title: Text
          type: string
        timestamp:
          anyOf:
          - maxLength: 40
            type: string
          - type: 'null'
          title: Timestamp
      required:
      - text
      title: MemoryUpdate
      type: object
    Message:
      description: A single conversation message passed to the POST /v1/memory endpoint
      properties:
        content:
          maxLength: 50000
          minLength: 1
          title: Content
          type: string
        role:
          enum:
          - user
          - assistant
          - system
          title: Role
          type: string
      required:
      - role
      - content
      title: Message
      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
    MetadataCombinationStrategy:
      description: Strategy to use when the dataset and the metadata file have duplicate
        columns.
      enum:
      - replace
      - merge
      title: MetadataCombinationStrategy
      type: string
    MetadataDatasetPairApiFormatted:
      description: Pair of metadata dataset and dataset added to the vector database.
      properties:
        datasetId:
          description: The ID of the dataset added to the vector database.
          title: datasetId
          type: string
        datasetName:
          description: The name of the dataset added to the vector database.
          title: datasetName
          type: string
        metadataDatasetId:
          description: The ID of the dataset used to add metadata to the vector database.
          title: metadataDatasetId
          type: string
        metadataDatasetName:
          description: The name of the dataset used to add metadata to the vector
            database.
          title: metadataDatasetName
          type: string
      required:
      - metadataDatasetId
      - datasetId
      - metadataDatasetName
      - datasetName
      title: MetadataDatasetPairApiFormatted
      type: object
    MetadataField:
      description: A custom metric metadata source when reading values from columnar
        datasets like a file.
      properties:
        columnName:
          description: Column name
          maxLength: 128
          type:
          - string
          - 'null'
      required:
      - columnName
      type: object
      x-versionadded: v2.36
    MetricBaselineValue:
      properties:
        value:
          description: A reference value in given metric units.
          type: number
      required:
      - value
      type: object
    MetricCategory:
      properties:
        categoryName:
          description: Category value.
          type: string
        count:
          description: Count of the categories in the bucket.
          type: integer
      required:
      - categoryName
      - count
      type: object
      x-versionadded: v2.35
    MetricCreateFromCustomJob:
      properties:
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        customJobId:
          description: Custom Job ID.
          type: string
        description:
          default: ''
          description: Description of the custom metric.
          maxLength: 1000
          type: string
        geospatialSegmentAttribute:
          description: Name of the column that contains geospatial values.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        name:
          description: Name of the custom metric.
          maxLength: 255
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
        schedule:
          $ref: '#/components/schemas/Schedule'
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        value:
          $ref: '#/components/schemas/ValueField'
      required:
      - customJobId
      - name
      type: object
      x-versionadded: v2.34
    MetricCreateFromCustomJobResponse:
      properties:
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        categories:
          description: Values of the categories. This field is required for categorical
            custom metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        createdAt:
          description: Hosted custom metric creation timestamp.
          format: date-time
          type: string
        deployment:
          $ref: '#/components/schemas/Deployment'
        description:
          default: ''
          description: Description of the custom metric.
          maxLength: 1000
          type: string
        directionality:
          description: Directionality of the custom metric.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type:
          - string
          - 'null'
        geospatialSegmentAttribute:
          description: Name of the column that contains geospatial values.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the custom metric.
          type: string
        isGeospatial:
          description: Determines whether the metric is geospatial.
          type: boolean
          x-versionadded: v2.36
        isModelSpecific:
          description: Determines whether the metric is related to the model or deployment.
          type: boolean
        name:
          description: Name of the custom metric.
          maxLength: 255
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
        schedule:
          $ref: '#/components/schemas/Schedule'
        timeStep:
          default: hour
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or the Y-axis label of the given custom metric.
          type:
          - string
          - 'null'
        value:
          $ref: '#/components/schemas/ValueField'
      required:
      - createdAt
      - deployment
      - directionality
      - id
      - isModelSpecific
      - name
      - timeStep
      - type
      - units
      type: object
      x-versionadded: v2.34
    MetricCreatePayload:
      properties:
        baselineValues:
          description: Baseline values. This field is required for numeric custom
            metrics.
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        categories:
          description: Values of the categories. This field is required for categorical
            custom metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        description:
          description: A description of the custom metric.
          maxLength: 1000
          type: string
        directionality:
          description: Directionality of the custom metric. This field is required
            for numeric custom metrics.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type:
          - string
          - 'null'
        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'
        timeStep:
          default: hour
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or the Y-axis label of the given custom metric. This
            field is required for numeric custom metrics.
          type:
          - string
          - 'null'
        value:
          $ref: '#/components/schemas/ValueField'
      required:
      - isModelSpecific
      - name
      - timeStep
      - type
      type: object
    MetricCreatedBy:
      description: The user that created custom metric.
      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:
      description: A custom metric definition.
      properties:
        associationId:
          $ref: '#/components/schemas/AssociationIdField'
          x-versionadded: v2.36
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        categories:
          description: Category values
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        createdAt:
          description: Custom metric creation timestamp.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/MetricCreatedBy'
        description:
          description: A description of the custom metric.
          maxLength: 1000
          type: string
        directionality:
          description: Directionality of the custom metric.
          enum:
          - higherIsBetter
          - lowerIsBetter
          type:
          - string
          - 'null'
        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
        metadata:
          $ref: '#/components/schemas/MetadataField'
          default: null
          x-versionadded: v2.36
        name:
          description: Name of the custom metric.
          type: string
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
        timeStep:
          description: Custom metric time bucket size.
          enum:
          - hour
          type: string
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type:
          - string
          - 'null'
        value:
          $ref: '#/components/schemas/ValueField'
      required:
      - createdAt
      - createdBy
      - id
      - isModelSpecific
      - name
      - timeStep
      - type
      type: object
    MetricGroups:
      properties:
        group:
          description: The metric group name.
          type: string
        value:
          description: The metric value.
          type: number
      required:
      - group
      - value
      type: object
      x-versionadded: v2.39
    MetricInputValueBucket:
      properties:
        associationId:
          default: null
          description: Identifies prediction row corresponding to value.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        geospatialCoordinate:
          description: A geospatial object in WKB or WKT format. Only required for
            geospatial custom metrics.
          maxLength: 10000
          type: string
          x-versionadded: v2.36
        metadata:
          default: null
          description: A read-only metadata association with a custom metric value.
          maxLength: 128
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        sampleSize:
          default: 1
          description: Custom metric value sample size.
          type: integer
        segments:
          description: A list of segments for a custom metric used in segmented analysis.
            Segments cannot be provided for geospatial metrics.
          items:
            $ref: '#/components/schemas/CustomMetricSegment'
          maxItems: 10
          type: array
          x-versionadded: v2.36
        timestamp:
          description: Value timestamp.
          format: date-time
          type:
          - string
          - 'null'
        value:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
          description: Custom metric value to ingest.
      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
          type:
          - string
          - 'null'
        previous:
          description: URL to the previous page, or null if there is no such page
          type:
          - string
          - 'null'
        totalCount:
          description: Total number of entries.
          minimum: 0
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    MetricMetadata:
      description: Prompt metric metadata.
      properties:
        costConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the cost configuration.
          title: costConfigurationId
        customModelGuardId:
          anyOf:
          - type: string
          - type: 'null'
          description: Id of the custom model guard.
          title: customModelGuardId
        customModelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model used for the metric.
          title: customModelId
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the metric computation.
          title: errorMessage
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset configuration.
          title: evaluationDatasetConfigurationId
        executionStatus:
          anyOf:
          - $ref: '#/components/schemas/ExecutionStatus'
          - type: 'null'
          description: The computation status of the metric.
        formattedName:
          anyOf:
          - type: string
          - type: 'null'
          description: The formatted name of the metric.
          title: formattedName
        formattedValue:
          anyOf:
          - type: string
          - type: 'null'
          description: The formatted value of the metric.
          title: formattedValue
        llmIsDeprecated:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the LLM is deprecated and will be removed in a future
            release.
          title: llmIsDeprecated
        name:
          description: The name of the metric.
          title: name
          type: string
        nemoMetricId:
          anyOf:
          - type: string
          - type: 'null'
          description: The id of the NeMo Pipeline configuration.
          title: nemoMetricId
        ootbMetricId:
          anyOf:
          - type: string
          - type: 'null'
          description: The id of the OOTB metric configuration.
          title: ootbMetricId
        sidecarModelMetricValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The validation ID of the sidecar model validation(in case of
            using a sidecar model deployment for the metric).
          title: sidecarModelMetricValidationId
        stage:
          anyOf:
          - $ref: '#/components/schemas/PipelineStage'
          - type: 'null'
          description: The stage (prompt or response) that the metric applies to.
        value:
          description: The value of the metric.
          title: value
      required:
      - name
      - value
      title: MetricMetadata
      type: object
    MetricPeriodBucket:
      description: A time period defined by a start and end time
      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:
      description: Summary of the custom metric.
      properties:
        baselineValue:
          description: Baseline value.
          type:
          - number
          - 'null'
        categories:
          description: Category values.
          items:
            $ref: '#/components/schemas/CustomMetricCategorySummary'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        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.
          type:
          - number
          - 'null'
        sampleCount:
          description: Number of samples used to calculate the aggregated value.
          type:
          - integer
          - 'null'
        unknownCategoriesCount:
          description: Count of unknown categories for categorical metrics.
          type:
          - number
          - 'null'
          x-versionadded: v2.35
        value:
          description: Aggregated value of the custom metric.
          type:
          - number
          - 'null'
      required:
      - id
      - name
      type: object
    MetricTimestampSpoofing:
      description: A custom metric timestamp spoofing when reading values from file,
        like dataset. By default, we replicate pd.to_datetime formatting behaviour.
      properties:
        columnName:
          description: Column name
          type:
          - string
          - 'null'
        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'
          type:
          - string
          - 'null'
      type: object
    MetricUnit:
      description: The unit of measurement associated with a metric.
      enum:
      - s
      - ms
      - '%'
      title: MetricUnit
      type: string
    MetricUpdatePayload:
      properties:
        baselineValues:
          description: Baseline values
          items:
            $ref: '#/components/schemas/MetricBaselineValue'
          maxItems: 5
          type: array
        batch:
          $ref: '#/components/schemas/BatchField'
        categories:
          description: Category values. This field is required for categorical custom
            metrics.
          items:
            $ref: '#/components/schemas/CustomMetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.36
        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'
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        type:
          description: Type (and aggregation character) of a metric.
          enum:
          - average
          - categorical
          - gauge
          - sum
          type: string
        units:
          description: Units or Y Label of given custom metric.
          type: string
        value:
          $ref: '#/components/schemas/ValueField'
      type: object
    MetricValue:
      properties:
        id:
          description: The ID of the custom metric.
          type: string
        metadata:
          default: null
          description: Custom metric value metadata.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        name:
          description: Custom metric name.
          type: string
        value:
          description: Custom metric value.
          oneOf:
          - type: number
          - type: string
          - type: 'null'
      required:
      - id
      - name
      - value
      type: object
      x-versionadded: v2.35
    MetricValuesFromDatasetPayload:
      properties:
        associationId:
          $ref: '#/components/schemas/BatchField'
        batch:
          $ref: '#/components/schemas/BatchField'
        datasetId:
          description: Dataset ID to process.
          type: string
        geospatial:
          $ref: '#/components/schemas/GeospatialCoordinateField'
          x-versionadded: v2.36
        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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        sampleCount:
          $ref: '#/components/schemas/SampleCountField'
        segments:
          description: A list of segments for a custom metric used in segmented analysis.
            Cannot be used with geospatial custom metrics.
          items:
            $ref: '#/components/schemas/CustomMetricSegmentDataset'
          maxItems: 10
          minItems: 1
          type: array
        timestamp:
          $ref: '#/components/schemas/MetricTimestampSpoofing'
        value:
          $ref: '#/components/schemas/ValueField'
      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 if the custom metric data calculated for this run
            is saved to the database.
          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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
      required:
      - buckets
      - dryRun
      type: object
    MetricValuesOverBatchBucket:
      properties:
        batch:
          $ref: '#/components/schemas/BucketBatch'
          x-versionadded: v2.33
        categories:
          description: Aggregated custom metric categories in the bucket.
          items:
            $ref: '#/components/schemas/MetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.35
        sampleSize:
          description: Total number of values aggregated in the bucket.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        unknownCategoriesCount:
          description: The count of the values that do not correspond to the any of
            the known categories.
          type:
          - integer
          - 'null'
          x-versionadded: v2.35
        value:
          description: Aggregated custom metric value in the bucket.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
      required:
      - batch
      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'
          x-versionadded: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        segmentValue:
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
      required:
      - buckets
      - metric
      type: object
    MetricValuesOverSpaceResponse:
      properties:
        buckets:
          description: A list of buckets containing aggregated custom metric values.
          items:
            $ref: '#/components/schemas/CustomMetricOverSpaceBucket'
          maxItems: 1000
          type: array
        metric:
          $ref: '#/components/schemas/MetricEntity'
        modelId:
          description: 'The ID of the model for which metrics are being retrieved. '
          type: string
        modelPackageId:
          description: The ID of the model package for which metrics are being retrieved.
          type:
          - string
          - 'null'
        summary:
          $ref: '#/components/schemas/MetricValuesOverTimeSummary'
      required:
      - buckets
      - metric
      - summary
      type: object
      x-versionadded: v2.36
    MetricValuesOverTimeBucket:
      properties:
        categories:
          description: Aggregated custom metric categories in the bucket.
          items:
            $ref: '#/components/schemas/MetricCategory'
          maxItems: 25
          type: array
          x-versionadded: v2.35
        period:
          $ref: '#/components/schemas/MetricPeriodBucket'
        sampleSize:
          description: Total number of values aggregated in the bucket.
          type:
          - integer
          - 'null'
        unknownCategoriesCount:
          description: The count of the values that do not correspond to the any of
            the known categories.
          type:
          - integer
          - 'null'
          x-versionadded: v2.35
        value:
          description: Aggregated custom metric value in the bucket.
          type:
          - number
          - 'null'
      required:
      - period
      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'
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        segmentValue:
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        summary:
          $ref: '#/components/schemas/MetricValuesOverTimeSummary'
      required:
      - buckets
      - metric
      - summary
      type: object
    MetricValuesOverTimeSummary:
      description: Summary of values over time retrieval.
      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
    MilvusConnection:
      description: Milvus vector database connection.
      properties:
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        type:
          const: milvus
          default: milvus
          description: The type of the external vector database.
          title: type
          type: string
        uri:
          description: The URI of the Milvus connection.
          maxLength: 5000
          minLength: 1
          title: uri
          type: string
      required:
      - credentialId
      - uri
      title: MilvusConnection
      type: object
    MilvusConnectionRequest:
      description: Milvus vector database connection.
      properties:
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        type:
          const: milvus
          default: milvus
          description: The type of the external vector database.
          title: type
          type: string
        uri:
          description: The URI of the Milvus connection.
          maxLength: 5000
          minLength: 1
          title: uri
          type: string
      required:
      - credentialId
      - uri
      title: MilvusConnectionRequest
      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:
      description: Information about the content of .mlpkg artifact
      properties:
        allTimeSeriesPredictionIntervals:
          description: Whether .mlpkg contains TS prediction intervals computed for
            all percentiles
          type:
          - boolean
          - 'null'
          x-versionadded: v2.31
      type: object
    ModelAdvancedTuning:
      properties:
        gridSearchArguments:
          $ref: '#/components/schemas/GridSearchArgument'
          x-versionadded: v2.38
        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
          x-versiondeprecated: v2.35
        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'
        supportsAccuracyOverTime:
          description: '`True` if Accuracy Over Time plots can be generated.'
          type: boolean
          x-versionadded: v2.34
        supportsAdvancedTuning:
          description: '`True` if model supports Advanced Tuning.'
          type: boolean
          x-versionadded: v2.36
        supportsAnomalyAssessment:
          description: '`True` if Anomaly Assessment insights can be generated.'
          type: boolean
          x-versionadded: v2.34
        supportsAnomalyOverTime:
          description: '`True` if Anomaly Over Time plots can be generated.'
          type: boolean
          x-versionadded: v2.34
        supportsBlending:
          description: '`True` if the model supports blending. See :http:post:`/api/v2/projects/(projectId)/blenderModels/blendCheck/`
            to check specific blending combinations.'
          type: boolean
        supportsClusterInsights:
          description: '`True` if Cluster Insights can be generated.'
          type: boolean
          x-versionadded: v2.34
        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
        supportsForecastAccuracy:
          description: '`True` if Forecast Accuracy plots can be generated.'
          type: boolean
          x-versionadded: v2.34
        supportsForecastVsActual:
          description: '`True` if Forecast vs Actual plots can be generated.'
          type: boolean
          x-versionadded: v2.34
        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
        supportsPerLabelMetrics:
          description: '`True` if the experiment qualifies as a multilabel project.'
          type: boolean
          x-versionadded: v2.36
        supportsPeriodAccuracy:
          description: '`True` if Period Accuracy insights can be generated.'
          type: boolean
          x-versionadded: v2.34
        supportsPredictionExplanations:
          description: '`True` if the model supports Prediction Explanations.'
          type: boolean
          x-versionadded: v2.34
        supportsPredictionIntervals:
          description: '`True` if Prediction Intervals can be computed for predictions
            generated by this model.'
          type: boolean
          x-versionadded: v2.34
        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
        supportsSeriesInsights:
          description: '`True` if Series Insights can be generated.'
          type: boolean
          x-versionadded: v2.34
        supportsShap:
          description: '`True` if the model supports Shapley package, i.e., Shapley-based
            feature importance.'
          type: boolean
          x-versionadded: v2.18
        supportsStability:
          description: '`True` if Stability plots can be generated.'
          type: boolean
          x-versionadded: v2.34
      required:
      - eligibleForPrime
      - hasParameters
      - hasWordCloud
      - supportsAccuracyOverTime
      - supportsAdvancedTuning
      - supportsAnomalyAssessment
      - supportsAnomalyOverTime
      - supportsBlending
      - supportsClusterInsights
      - supportsCodeGeneration
      - supportsCoefficients
      - supportsConfusionMatrix
      - supportsDocumentTextExtractionSampleInsight
      - supportsForecastAccuracy
      - supportsForecastVsActual
      - supportsImageActivationMaps
      - supportsImageEmbedding
      - supportsLiftChart
      - supportsModelTrainingMetrics
      - supportsMonotonicConstraints
      - supportsNNVisualizations
      - supportsPerLabelMetrics
      - supportsPredictionExplanations
      - supportsPredictionIntervals
      - supportsResiduals
      - supportsRocCurve
      - supportsSeriesInsights
      - supportsShap
      - supportsStability
      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'
        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'
        globalMetrics:
          $ref: '#/components/schemas/GlobalMetrics'
        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:
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          type:
          - string
          - 'null'
          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.
          type: object
        modelCategory:
          description: Indicates the type 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 the 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: 0
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          type:
          - integer
          - 'null'
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          type:
          - string
          - 'null'
        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: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
        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: 100
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          type:
          - string
          - 'null'
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          type:
          - string
          - 'null'
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          type:
          - string
          - 'null'
      required:
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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
    ModelHistoryListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: History of deployment's champion models, including the current
            champion model.
          items:
            $ref: '#/components/schemas/ModelHistoryResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    ModelHistoryResponse:
      properties:
        customModelImage:
          $ref: '#/components/schemas/CustomModelImage'
        endDate:
          description: The timestamp when the model is replaced by another model.
          format: date-time
          type:
          - string
          - 'null'
        forecastEndDate:
          description: The max timestamp of all predictions made when the model is
            or was champion of the deployment, if predictions by forecast date is
            enabled.
          format: date-time
          type:
          - string
          - 'null'
        forecastStartDate:
          description: The min timestamp of all predictions made when the model is
            or was champion of the deployment, if predictions by forecast date is
            enabled.
          format: date-time
          type:
          - string
          - 'null'
        modelPackage:
          $ref: '#/components/schemas/ModelPackageObject'
        predictionWarningBoundaries:
          $ref: '#/components/schemas/ModelPackagePredictionThresholdWarning'
        replacementReason:
          description: Reason for model replacement.
          type:
          - string
          - 'null'
        startDate:
          description: The timestamp when the model becomes champion of the deployment.
          format: date-time
          type: string
      required:
      - endDate
      - forecastEndDate
      - forecastStartDate
      - modelPackage
      - replacementReason
      - startDate
      type: object
      x-versionadded: v2.36
    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: Whether 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: The 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:
      description: Object returning model lifecycle.
      properties:
        reason:
          description: The reason for the lifecycle stage. None if the model is active.
          type:
          - string
          - 'null'
          x-versionadded: v2.30
        stage:
          description: The 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
    ModelPackageCapabilities:
      description: Capabilities of the current model package.
      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
    ModelPackageCreateExternal:
      properties:
        datasets:
          $ref: '#/components/schemas/ModelPackageDatasetsCreate'
        geospatialMonitoring:
          $ref: '#/components/schemas/ModelPackageExternalGeospatialMonitoring'
        modelDescription:
          $ref: '#/components/schemas/ModelPackageModelDescriptionCreate'
        modelId:
          description: The ID of the model.
          type: string
        name:
          description: The model package name.
          maxLength: 1024
          type: string
        registeredModelName:
          description: The registered model name.
          maxLength: 1024
          type: string
          x-versionadded: v2.39
        target:
          $ref: '#/components/schemas/ModelPackageTargetCreate'
        textGeneration:
          $ref: '#/components/schemas/ModelPackageTextGeneration'
        timeseries:
          $ref: '#/components/schemas/ModelPackageTimeseriesCreate'
      required:
      - name
      - target
      type: object
      x-versionadded: v2.37
    ModelPackageCreateFromLeaderboard:
      properties:
        computeAllTsIntervals:
          default: null
          description: Whether to compute all Time Series prediction intervals (1-100
            percentiles)
          type:
          - boolean
          - 'null'
        description:
          default: ''
          description: Description of the model package.
          maxLength: 2048
          type:
          - string
          - 'null'
        distributionPredictionModelId:
          default: null
          description: ID of the DataRobot distribution prediction model trained on
            predictions from the DataRobot model.
          type:
          - string
          - 'null'
        modelId:
          description: ID of the DataRobot model.
          type: string
        name:
          default: null
          description: Name of the model package.
          maxLength: 1024
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        distributionPredictionModelId:
          default: null
          description: ID of the DataRobot distribution prediction model trained on
            predictions from the DataRobot model.
          type:
          - string
          - 'null'
        modelId:
          description: ID of the DataRobot model.
          type: string
        name:
          default: null
          description: Name of the model package.
          maxLength: 1024
          type:
          - string
          - 'null'
        predictionThreshold:
          description: Threshold used for binary classification in predictions
          maximum: 1.0
          minimum: 0.0
          type: number
      required:
      - modelId
      type: object
    ModelPackageDatasets:
      description: dataset information for the model package
      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
          type: array
        datasetName:
          description: Name of dataset used to train the model
          type:
          - string
          - 'null'
        holdoutDataCatalogId:
          description: ID for holdout data (returned from uploading a data set)
          type:
          - string
          - 'null'
        holdoutDataCatalogVersionId:
          description: Version ID for holdout data (returned from uploading a data
            set)
          type:
          - string
          - 'null'
        holdoutDataCreatedAt:
          description: Time when the holdout data item was created
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        holdoutDataCreatorEmail:
          description: Email of the user who created the holdout data item
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        holdoutDataCreatorId:
          default: null
          description: ID of the creator of the holdout data item
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        holdoutDataCreatorName:
          description: Name of the user who created the holdout data item
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        holdoutDatasetName:
          description: Name of dataset used for model holdout
          type:
          - string
          - 'null'
        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)
          type:
          - string
          - 'null'
        trainingDataCatalogVersionId:
          description: Version ID for training data (returned from uploading a data
            set)
          type:
          - string
          - 'null'
        trainingDataCreatedAt:
          description: Time when the training data item was created
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        trainingDataCreatorEmail:
          description: Email of the user who created the training data item
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        trainingDataCreatorId:
          default: null
          description: ID of the creator of the training data item
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        trainingDataCreatorName:
          description: Name of the user who created the training data item
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        trainingDataSize:
          description: Number of rows in training data (used by DR models)
          type: integer
      required:
      - baselineSegmentedBy
      - datasetName
      - holdoutDataCatalogId
      - holdoutDataCatalogVersionId
      - holdoutDatasetName
      - trainingDataCatalogId
      - trainingDataCatalogVersionId
      type: object
    ModelPackageDatasetsCreate:
      description: The dataset information for the model package.
      properties:
        holdoutDataCatalogId:
          description: The ID for Holdout data (returned from uploading a dataset).
          type:
          - string
          - 'null'
        holdoutDataCatalogVersionId:
          description: The version ID for Holdout data (returned from uploading a
            dataset).
          type:
          - string
          - 'null'
        trainingDataCatalogId:
          description: The ID for training data (returned from uploading a dataset).
          type:
          - string
          - 'null'
        trainingDataCatalogVersionId:
          description: The version ID for training data (returned from uploading a
            dataset).
          type:
          - string
          - 'null'
      type: object
      x-versionadded: v2.37
    ModelPackageExternalGeospatialMonitoring:
      description: Geospatial monitoring information for the model package
      properties:
        primaryLocationColumn:
          description: The name of the geo-analysis column,
          type:
          - string
          - 'null'
      required:
      - primaryLocationColumn
      type: object
      x-versionadded: v2.37
    ModelPackageImportMeta:
      description: Information from when this Model Package was first saved
      properties:
        containsFearPipeline:
          description: Exists for imported models only, indicates thatmodel package
            contains file with fear pipeline.
          type:
          - boolean
          - 'null'
        containsFeaturelists:
          description: Exists for imported models only, indicates thatmodel package
            contains file with featurelists.
          type:
          - boolean
          - 'null'
        containsLeaderboardMeta:
          description: Exists for imported models only, indicates thatmodel package
            contains file with leaderboard meta.
          type:
          - boolean
          - 'null'
        containsProjectMeta:
          description: Exists for imported models only, indicates thatmodel package
            contains file with project meta.
          type:
          - boolean
          - 'null'
        creatorFullName:
          description: The full name of the person who created this model package.
          type:
          - string
          - 'null'
        creatorId:
          description: The user ID of the person who created this model package.
          type: string
        creatorUsername:
          description: The 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
          type:
          - string
          - 'null'
      required:
      - creatorFullName
      - creatorId
      - creatorUsername
      - dateCreated
      - originalFileName
      type: object
    ModelPackageListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    ModelPackageModelDescription:
      description: model description information for the model package
      properties:
        buildEnvironmentType:
          description: build environment type of the model
          enum:
          - DataRobot
          - Python
          - R
          - Java
          - Other
          type: string
        description:
          description: a description of the model
          type:
          - string
          - 'null'
        location:
          description: location of the model
          type:
          - string
          - 'null'
        modelCreatedAt:
          description: time when the model was created
          type:
          - string
          - 'null'
        modelCreatorEmail:
          description: email of the user who created the model
          type:
          - string
          - 'null'
        modelCreatorId:
          default: null
          description: ID of the creator of the model
          type:
          - string
          - 'null'
        modelCreatorName:
          description: name of the user who created the model
          type:
          - string
          - 'null'
        modelName:
          description: model name
          type: string
      required:
      - buildEnvironmentType
      - description
      - location
      type: object
    ModelPackageModelDescriptionCreate:
      description: The model description information for the model package.
      properties:
        buildEnvironmentType:
          description: The build environment type of the model.
          enum:
          - DataRobot
          - Python
          - R
          - Java
          - Julia
          - Legacy
          - Other
          type: string
        description:
          description: A description of the model.
          maxLength: 2048
          type:
          - string
          - 'null'
        location:
          description: The location of the model.
          maxLength: 2048
          type:
          - string
          - 'null'
        modelName:
          description: The model name.
          maxLength: 512
          type: string
      type: object
      x-versionadded: v2.37
    ModelPackageModelKind:
      description: Model attribute information
      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
        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
      - isFeatureDiscovery
      - isMultiseries
      - isTimeSeries
      - isUnsupervisedLearning
      type: object
    ModelPackageModelLogsEntry:
      properties:
        level:
          description: The name of the level of the logging event.
          enum:
          - DEBUG
          - INFO
          - WARNING
          - ERROR
          - CRITICAL
          type: string
        message:
          description: The message of the logging event.
          type: string
        time:
          description: The POSIX time of the logging event.
          type: number
      required:
      - level
      - message
      - time
      type: object
      x-versionadded: v2.35
    ModelPackageModelLogsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The log entries.
          items:
            $ref: '#/components/schemas/ModelPackageModelLogsEntry'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    ModelPackageObject:
      description: Contains information about the model package.
      properties:
        id:
          description: ID of the model package.
          type:
          - string
          - 'null'
        modelId:
          description: ID of the model.
          type: string
        name:
          description: Name of the model package.
          type:
          - string
          - 'null'
        predictionThreshold:
          description: The threshold value used for binary classification prediction.
          type:
          - number
          - 'null'
        projectId:
          description: ID of the project.
          type: string
        registeredModelId:
          description: ID of the associated registered model.
          type:
          - string
          - 'null'
      required:
      - id
      - modelId
      - name
      - predictionThreshold
      - registeredModelId
      type: object
      x-versionadded: v2.36
    ModelPackagePredictionThresholdWarning:
      description: Lower and upper boundaries for outlier detection.
      properties:
        lower:
          description: Lower boundary for outlier detection.
          type: number
        upper:
          description: Upper boundary for outlier detection.
          type: number
      required:
      - lower
      - upper
      type: object
      x-versionadded: v2.36
    ModelPackageResponse:
      description: modelPackage of the challenger.
      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
          type:
          - string
          - 'null'
      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
          type:
          - string
          - 'null'
        capabilities:
          $ref: '#/components/schemas/ModelPackageCapabilities'
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        datasets:
          $ref: '#/components/schemas/ModelPackageDatasets'
        id:
          description: The ID of the model package.
          type: string
        importMeta:
          $ref: '#/components/schemas/ModelPackageImportMeta'
        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'
          x-versionadded: v2.31
        modelDescription:
          $ref: '#/components/schemas/ModelPackageModelDescription'
        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: The ID of the model.
          type: string
        modelKind:
          $ref: '#/components/schemas/ModelPackageModelKind'
        name:
          description: The 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'
        target:
          $ref: '#/components/schemas/ModelPackageTarget'
        timeseries:
          $ref: '#/components/schemas/ModelPackageTimeseries'
        updatedBy:
          $ref: '#/components/schemas/UserMetadata'
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        capabilities:
          $ref: '#/components/schemas/ModelPackageCapabilities'
          x-versionadded: v2.25.2
          x-versiondeprecated: v2.29
        datasets:
          $ref: '#/components/schemas/ModelPackageDatasets'
          x-versionadded: v2.33
        id:
          description: The ID of the model package.
          type: string
          x-versionadded: v2.33
        importMeta:
          $ref: '#/components/schemas/ModelPackageImportMeta'
          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'
          x-versionadded: v2.31
        modelDescription:
          $ref: '#/components/schemas/ModelPackageModelDescription'
          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: The ID of the model.
          type: string
          x-versionadded: v2.33
        modelKind:
          $ref: '#/components/schemas/ModelPackageModelKind'
          x-versionadded: v2.33
        name:
          description: The model package name.
          type: string
          x-versionadded: v2.33
        sourceMeta:
          $ref: '#/components/schemas/ModelPackageSourceMeta'
          x-versionadded: v2.33
        target:
          $ref: '#/components/schemas/ModelPackageTarget'
          x-versionadded: v2.33
        timeseries:
          $ref: '#/components/schemas/ModelPackageTimeseries'
          x-versionadded: v2.33
        updatedBy:
          $ref: '#/components/schemas/UserMetadata'
          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:
      description: If available, information about the model's scoring code
      properties:
        dataRobotPredictionVersion:
          description: The DataRobot prediction API version for the scoring code.
          type:
          - string
          - 'null'
        location:
          description: The location of the scoring code.
          enum:
          - local_leaderboard
          - mlpkg
          type:
          - string
          - 'null'
      required:
      - dataRobotPredictionVersion
      - location
      type: object
    ModelPackageSourceMeta:
      description: Meta information from where this model was generated
      properties:
        customModelDetails:
          $ref: '#/components/schemas/CustomModelDetails'
          x-versionadded: v2.34
        environmentUrl:
          description: If available, URL of the source model
          format: uri
          type:
          - string
          - 'null'
        fips_140_2Enabled:
          description: true if the model was built with FIPS-140-2
          type: boolean
        projectCreatedAt:
          description: If available, the time when the project was created.
          type:
          - string
          - 'null'
        projectCreatorEmail:
          description: If available, the email of the user who created the project.
          type:
          - string
          - 'null'
        projectCreatorId:
          default: null
          description: If available, the ID of the creator of the project.
          type:
          - string
          - 'null'
        projectCreatorName:
          description: If available, the name of the user who created the project.
          type:
          - string
          - 'null'
        projectId:
          description: If available, the project ID used for this model.
          type:
          - string
          - 'null'
        projectName:
          description: If available, the project name for this model.
          type:
          - string
          - 'null'
        scoringCode:
          $ref: '#/components/schemas/ModelPackageScoringCodeMeta'
        useCaseDetails:
          $ref: '#/components/schemas/UseCaseDetails'
      required:
      - environmentUrl
      - projectId
      - projectName
      - scoringCode
      type: object
    ModelPackageTarget:
      description: target information for the model package
      properties:
        classCount:
          description: Number of classes for classification models.
          minimum: 0
          type:
          - integer
          - 'null'
        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
          type: array
        name:
          description: Name of the target column
          type:
          - string
          - 'null'
        predictionProbabilitiesColumn:
          description: Field or column name containing prediction probabilities
          type:
          - string
          - 'null'
        predictionThreshold:
          description: Prediction threshold used for binary classification models
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        type:
          description: Target type of the model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Multilabel
          - TextGeneration
          - GeoPoint
          - AgenticWorkflow
          - MCP
          type: string
      required:
      - classCount
      - classNames
      - name
      - predictionProbabilitiesColumn
      - predictionThreshold
      - type
      type: object
    ModelPackageTargetCreate:
      description: The target information for the model package.
      properties:
        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.
          items:
            maxLength: 128
            type: string
          maxItems: 1000
          type: array
        name:
          description: Name of the target column
          maxLength: 128
          type:
          - string
          - 'null'
        predictionProbabilitiesColumn:
          description: Field or column name containing prediction probabilities
          maxLength: 128
          type:
          - string
          - 'null'
        predictionThreshold:
          description: Prediction threshold used for binary classification models
          maximum: 1
          minimum: 0
          type:
          - number
          - 'null'
        type:
          description: Target type of the model.
          enum:
          - Binary
          - Regression
          - Multiclass
          - Multilabel
          - TextGeneration
          - GeoPoint
          - AgenticWorkflow
          - MCP
          type: string
      required:
      - type
      type: object
      x-versionadded: v2.37
    ModelPackageTextGeneration:
      description: Text generation information for the model package
      properties:
        prompt:
          description: Name of the prompt column
          type:
          - string
          - 'null'
      required:
      - prompt
      type: object
      x-versionadded: v2.37
    ModelPackageTimeseries:
      description: time series information for the model package
      properties:
        datetimeColumnFormat:
          description: Date format for forecast date and forecast point column
          type:
          - string
          - 'null'
        datetimeColumnName:
          description: Name of the forecast date column
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
        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
          type:
          - integer
          - 'null'
        forecastDistanceColumnName:
          description: Name of the forecast distance column
          type:
          - string
          - 'null'
        forecastDistances:
          description: List of integer forecast distances
          items:
            type: integer
          type: array
        forecastDistancesTimeUnit:
          description: The time unit of forecast distances
          enum:
          - MICROSECOND
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type:
          - string
          - 'null'
        forecastPointColumnName:
          description: Name of the forecast point column
          type:
          - string
          - 'null'
        isCrossSeries:
          description: true if the model is cross-series.
          type:
          - boolean
          - 'null'
        isNewSeriesSupport:
          description: true if the model is optimized to support new series.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.25
        isTraditionalTimeSeries:
          description: true if the model is traditional time series.
          type:
          - boolean
          - 'null'
        seriesColumnName:
          description: Name of the series column in case of multi-series date
          type:
          - string
          - 'null'
      required:
      - datetimeColumnFormat
      - datetimeColumnName
      - effectiveFeatureDerivationWindowEnd
      - effectiveFeatureDerivationWindowStart
      - featureDerivationWindowEnd
      - featureDerivationWindowStart
      - forecastDistanceColumnName
      - forecastDistances
      - forecastDistancesTimeUnit
      - forecastPointColumnName
      - isCrossSeries
      - isNewSeriesSupport
      - isTraditionalTimeSeries
      - seriesColumnName
      type: object
    ModelPackageTimeseriesCreate:
      description: Time series information for the model package.
      properties:
        datetimeColumnFormat:
          description: The date format for the forecast date and forecast point column.
          type:
          - string
          - 'null'
        datetimeColumnName:
          description: The name of the forecast date column.
          type:
          - string
          - 'null'
        effectiveFeatureDerivationWindowEnd:
          description: A negative number or zero describing the end of the rolling
            window used to derive new features for the modeling dataset. This is relative
            to the forecast point, and the units are the forecast distances time units.
            When the dataset goes through aim, the pipeline reads the full dataset
            and calculates the "real" window (i.e., the effective FDW). For most models,
            eFDW is approximately the same as the FDW.
          maximum: 0
          type:
          - integer
          - 'null'
          x-versionadded: v2.37
        effectiveFeatureDerivationWindowStart:
          description: A negative number or zero describing the start of the rolling
            window used to derive new features for the modeling dataset. This is relative
            to the forecast point, and the units are the forecast distances time units.
            When the dataset goes through aim, the pipeline reads the full dataset
            and calculates the "real" window (i.e., the effective FDW). For most models,
            eFDW is approximately the same as the FDW.
          maximum: 0
          type:
          - integer
          - 'null'
          x-versionadded: v2.37
        featureDerivationWindowEnd:
          description: A negative number or zero defining the end point of the rolling
            window used to derive new features for the modeling dataset. This is relative
            to the forecast point, and the units are the forecast distances time units.
            For example, -7 days would mean the feature derivation would be done with
            data ending at 7 days ago.
          maximum: 0
          type:
          - integer
          - 'null'
        featureDerivationWindowStart:
          description: A negative number or zero defining the start point of the rolling
            window used to derive new features for the modeling dataset. This is relative
            to the forecast point, and the units are the forecast distances time units.
            For example, -28 days would means the feature derivation would be done
            with data starting from 28 days ago.
          maximum: 0
          type:
          - integer
          - 'null'
        forecastDistanceColumnName:
          description: The name of the forecast distance column.
          type:
          - string
          - 'null'
        forecastDistances:
          description: A list of integer forecast distances.
          items:
            type: integer
          type: array
        forecastDistancesTimeUnit:
          description: The time unit of forecast distances.
          enum:
          - MICROSECOND
          - MILLISECOND
          - SECOND
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          - QUARTER
          - YEAR
          type: string
        forecastPointColumnName:
          description: The name of the forecast point column.
          type:
          - string
          - 'null'
        isCrossSeries:
          description: true if the model is cross-series.
          type:
          - boolean
          - 'null'
        isNewSeriesSupport:
          default: false
          description: true if the model is optimized to support new series.
          type:
          - boolean
          - 'null'
        isTraditionalTimeSeries:
          default: false
          description: Determines if the model is a traditional time series model.
          type:
          - boolean
          - 'null'
        seriesColumnName:
          description: The name of the series column in the case of a multi-series
            date.
          type:
          - string
          - 'null'
      required:
      - datetimeColumnFormat
      - datetimeColumnName
      - forecastDistanceColumnName
      - forecastDistancesTimeUnit
      - forecastPointColumnName
      type: object
      x-versionadded: v2.37
    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:
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
          x-versionadded: v2.33
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        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.
          type: object
          x-versionadded: v2.33
        modelCategory:
          description: Indicates the type 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 (e.g.,
            Support Vector Machine, Gradient Boosting Machine, etc.).
          type: string
          x-versionadded: v2.33
        modelNumber:
          description: The model number from the Leaderboard.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        processes:
          description: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
      required:
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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'
            - $ref: '#/components/schemas/UnsupervisedClusteringModelRecordResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
          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
        runtimeParameterValues:
          description: "Inject values into a model at runtime. The fieldName must\
            \ match a fieldName defined in the model package. This list is merged\
            \ with any existing runtime values set through the deployed model package.\n\
            \                    <blockquote>This property is gated behind the feature\
            \ flags **`['CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT']`**.\n\
            \                    To enable this feature, you can contact your DataRobot\
            \ representative or administrator.\n                    </blockquote>"
          feature_flags:
          - &id002
            description: Enables the ability to edit Custom Model Runtime-Parameters
              (and replica and resource bundle settings) directly from the Deployment
              info page. Edited values are local to a given Deployment and do not
              affect the runtime of any current or future Deployments of the same
              Model Package.
            enabled_by_default: true
            maturity: PUBLIC_PREVIEW
            name: CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT
          public_preview: true
          type: string
          x-datarobot-public-preview: true
          x-datarobot-required-feature-flags:
          - *id002
          x-versionadded: v2.35
      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'
        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:
      description: Chart data from the validation data source
      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'
      required:
      - residuals
      type: object
    ModelResidualsSource:
      description: Residuals chart data from all available sources
      properties:
        crossValidation:
          $ref: '#/components/schemas/ModelResidualsChartData'
        holdout:
          $ref: '#/components/schemas/ModelResidualsChartData'
        validation:
          $ref: '#/components/schemas/ModelResidualsChartData'
      type: object
    ModelResponse:
      description: Model of the challenger.
      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
          type:
          - number
          - 'null'
        kolmogorovSmirnovMetric:
          description: Kolmogorov-Smirnov metric value
          type:
          - number
          - 'null'
        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
    ModelSnippetModel:
      properties:
        modelId:
          description: The selected model ID.
          type: string
        projectId:
          description: The selected project ID.
          type: string
        showSecrets:
          default: 'False'
          description: If true, the DATAROBOT_KEY and DATAROBOT_API_KEY will be available
            in the context.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      required:
      - modelId
      - projectId
      type: object
      x-versionadded: v2.35
    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: The list of sources available for the model.
          items:
            enum:
            - training
            - validation
            - holdout
            type: string
          type: array
        status:
          description: The status of the job.
          enum:
          - INPROGRESS
          - COMPLETED
          - NOT_COMPLETED
          type: string
      required:
      - backtestIndex
      - sources
      - status
      type: object
    ModelXrayMetadataDatetimeResponse:
      properties:
        data:
          description: The list of objects with status and sources for each backtest.
          items:
            $ref: '#/components/schemas/ModelXrayMetadataDatetimeDataResponse'
          type: array
      required:
      - data
      type: object
    ModelXrayMetadataResponse:
      properties:
        sources:
          description: The list of sources available for the model.
          items:
            enum:
            - training
            - validation
            - holdout
            type: string
          type: array
        status:
          description: The status of the job.
          enum:
          - INPROGRESS
          - COMPLETED
          - NOT_COMPLETED
          type: string
      required:
      - sources
      - status
      type: object
    ModelingFeatureListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: Modeling features data.
          items:
            $ref: '#/components/schemas/ModelingFeatureResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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 .
          type:
          - string
          - 'null'
          x-versionadded: v2.5
        featureLineageId:
          description: The ID of the lineage for automatically generated features.
          type:
          - string
          - 'null'
          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)
          type:
          - number
          - 'null'
        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
          type:
          - boolean
          - 'null'
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            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
        lowerQuartile:
          description: Lower quartile point of EDA sample of the feature.
          oneOf:
          - description: Lower quartile point of EDA sample of the feature.
            type: string
          - description: Lower quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
        max:
          description: maximum value of the EDA sample of the feature.
          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
          - type: 'null'
        mean:
          description: arithmetic mean of the EDA sample of the feature.
          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
          - type: 'null'
        median:
          description: median of the EDA sample of the feature.
          oneOf:
          - description: median of the EDA sample of the feature.
            type: string
          - description: median of the EDA sample of the feature.
            type: number
          - type: 'null'
        min:
          description: minimum value of the EDA sample of the feature.
          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
          - type: 'null'
        multilabelInsights:
          $ref: '#/components/schemas/MultilabelInsightsResponse'
          x-versionadded: v2.24
        naCount:
          description: Number of missing values.
          type: integer
        name:
          description: The 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.
          oneOf:
          - description: standard deviation of EDA sample of the feature.
            type: string
          - description: standard deviation of EDA sample of the feature.
            type: number
          - type: 'null'
        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
        upperQuartile:
          description: Upper quartile point of EDA sample of the feature.
          oneOf:
          - description: Upper quartile point of EDA sample of the feature.
            type: string
          - description: Upper quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
      required:
      - dateFormat
      - featureLineageId
      - featureType
      - importance
      - lowInformation
      - lowerQuartile
      - max
      - mean
      - median
      - min
      - naCount
      - name
      - projectId
      - stdDev
      - targetLeakage
      - targetLeakageReason
      - upperQuartile
      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
    ModerationAction:
      description: The moderation strategy.
      enum:
      - block
      - report
      - reportAndBlock
      title: ModerationAction
      type: string
    ModerationConfigurationWithID:
      description: Moderation Configuration associated with an insight.
      properties:
        guardConditions:
          description: The guard conditions associated with a metric.
          items:
            $ref: '#/components/schemas/GuardCondition'
          maxItems: 1
          minItems: 1
          title: guardConditions
          type: array
        intervention:
          $ref: '#/components/schemas/Intervention'
          description: The intervention specific moderation configuration.
      required:
      - guardConditions
      - intervention
      title: ModerationConfigurationWithID
      type: object
    ModerationConfigurationWithoutID:
      description: Moderation Configuration associated with an insight.
      properties:
        guardConditions:
          description: The guard conditions associated with a metric.
          items:
            $ref: '#/components/schemas/GuardCondition'
          maxItems: 1
          minItems: 1
          title: guardConditions
          type: array
        intervention:
          $ref: '#/components/schemas/Intervention'
          description: The intervention specific moderation configuration.
      required:
      - guardConditions
      - intervention
      title: ModerationConfigurationWithoutID
      type: object
    ModerationData:
      description: The moderation event information.
      properties:
        guardName:
          description: Name or label of the guard.
          maxLength: 255
          type: string
        metricName:
          description: Name or label of the metric.
          maxLength: 255
          type: string
      required:
      - guardName
      - metricName
      type: object
      x-versionadded: v2.35
    ModifyUsersInGroup:
      properties:
        users:
          description: The users to change membership for.
          items:
            $ref: '#/components/schemas/Username'
          maxItems: 100
          type: array
      required:
      - users
      type: object
    MonitoringAggregation:
      description: Defines the aggregation policy for monitoring jobs.
      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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        batchPredictionJobStatus:
          default: null
          description: Status of the batch prediction job associated with the batch
          enum:
          - INITIALIZING
          - RUNNING
          - COMPLETED
          - ABORTED
          - FAILED
          - null
          type:
          - string
          - 'null'
          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'
          x-versionadded: v2.33
        description:
          description: Description of the monitoring batch.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          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'
          x-versionadded: v2.33
      required:
      - batchPredictionJobId
      - 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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        externalContextUrl:
          description: External URL associated with the batch.
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        isLocked:
          description: Whether or not predictions can be added to the batch
          type:
          - boolean
          - 'null'
          x-versionadded: v2.33
      type: object
    MonitoringBatchCreator:
      description: Creator of the monitoring batch.
      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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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:
      description: Service health of the monitoring batch.
      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:
      description: Column names mapping for monitoring
      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'
            maxItems: 100
            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
          maxItems: 100
          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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      required:
      - modelId
      type: object
    MonitoringOutputSettings:
      description: Output settings for monitoring jobs
      properties:
        monitoredStatusColumn:
          description: Column name used to mark monitored rows.
          type: string
        uniqueRowIdentifierColumns:
          description: Column(s) name of unique row identifiers.
          items:
            type: string
          maxItems: 100
          type: array
      required:
      - monitoredStatusColumn
      - uniqueRowIdentifierColumns
      type: object
    MoveCellRequest:
      description: Request payload values for moving a notebook cell.
      properties:
        actionId:
          description: Action ID of notebook update request.
          maxLength: 64
          title: Actionid
          type: string
        afterCellId:
          anyOf:
          - type: string
          - enum:
            - FIRST
            type: string
          description: ID of the cell after which to move the cell.
          title: Aftercellid
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - generation
      - path
      - afterCellId
      title: MoveCellRequest
      type: object
    MoveFilesystemObjectRequest:
      description: Move filesystem object request schema.
      properties:
        operations:
          description: List of source-destination pairs.
          items:
            $ref: '#/components/schemas/SourceDestinationSchema'
          title: Operations
          type: array
      title: MoveFilesystemObjectRequest
      type: object
    MultiContainerArtifactSpec:
      additionalProperties: false
      properties:
        containerGroups:
          default: []
          description: List of container groups.
          items:
            $ref: '#/components/schemas/ContainerGroup'
          title: Containergroups
          type: array
      title: MultiContainerArtifactSpec
      type: object
    MultiNotebookOperationQuery:
      description: Base query schema for multiple notebook operations.
      properties:
        path:
          description: List of paths to the notebooks.
          items:
            type: string
          title: Path
          type: array
      title: MultiNotebookOperationQuery
      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: The 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:
      description: Error data.
      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.
          type:
          - string
          - 'null'
        rowIndex:
          description: Row index of the row containing format error.
          type:
          - integer
          - 'null'
      required:
      - error
      - feature
      - rowData
      - rowIndex
      type: object
    MulticategoricalInvalidFormatResponse:
      properties:
        data:
          $ref: '#/components/schemas/MulticategoricalInvalidFormatErrorData'
        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: The number of items returned on this page.
          type: integer
        data:
          description: The list of feature effect scores for each class in a multiclass
            project.
          items:
            $ref: '#/components/schemas/MulticlassFeatureEffects'
          type: array
        modelId:
          description: The model ID.
          type: string
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        projectId:
          description: The project ID.
          type: string
        source:
          description: The model's 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
          type: array
        rowCount:
          description: The number of rows from dataset to use for Feature Impact calculation.
          maximum: 100000
          minimum: 10
          type:
          - integer
          - 'null'
          x-versionadded: v2.21
        topNFeatures:
          description: Number of top features (ranked by feature impact) to use to
            calculate feature effects.
          exclusiveMinimum: 0
          maximum: 1000
          type:
          - integer
          - 'null'
      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
          type: array
        rowCount:
          description: The number of rows from dataset to use for Feature Impact calculation.
          maximum: 100000
          minimum: 10
          type:
          - integer
          - 'null'
          x-versionadded: v2.21
        topNFeatures:
          description: Number of top features (ranked by feature impact) to use to
            calculate feature effects.
          exclusiveMinimum: 0
          maximum: 1000
          type:
          - integer
          - 'null'
      required:
      - backtestIndex
      type: object
    MulticlassFeatureEffects:
      properties:
        class:
          description: Target class label.
          type: string
        featureImpactScore:
          description: The feature impact score.
          type: number
        featureName:
          description: The name of the feature.
          type: string
        featureType:
          description: The 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.
          type:
          - boolean
          - 'null'
        partialDependence:
          $ref: '#/components/schemas/PartialDependence'
        predictedVsActual:
          $ref: '#/components/schemas/PredictedVsActual'
        weightLabel:
          description: The weight label if a weight was configured for the project.
          type:
          - string
          - 'null'
      required:
      - class
      - featureImpactScore
      - featureName
      - featureType
      - isBinnable
      - isScalable
      - weightLabel
      type: object
    MulticlassFeatureEffectsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of feature effect scores for each class in a multiclass
            project.
          items:
            $ref: '#/components/schemas/MulticlassFeatureEffects'
          type: array
        modelId:
          description: The model ID.
          type: string
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        projectId:
          description: The project ID.
          type: string
        source:
          description: The model's 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: The URL for the next page of results, or null if there is no
            next page.
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL for the previous page of results, or null if there
            is no previous page.
          format: uri
          type:
          - string
          - 'null'
        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: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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: The list of lift chart data for each target class.
          items:
            $ref: '#/components/schemas/MulticlassLiftDataClassBins'
          type: array
        datasetId:
          description: The dataset ID of the dataset that was used to compute the
            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:
      description: Multilabel project specific information
      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
    MultipleNotebooksSharedRole:
      properties:
        notebookId:
          description: The ID of the notebook.
          type: string
        roles:
          description: Individual roles data for the notebook.
          items:
            $ref: '#/components/schemas/NotebookSharedRole'
          type: array
      required:
      - notebookId
      - roles
      type: object
      x-versionadded: v2.35
    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:
      description: The detected multiseries ID columns along with timeStep and timeUnit
        information.
      properties:
        multiseriesIdColumns:
          description: The 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: The detected time step.
          type: integer
        timeUnit:
          description: The 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:
      description: The data fields of the multiseries names.
      properties:
        items:
          description: The list of series names.
          items:
            description: Name of one series item
            type: string
          type: array
      required:
      - items
      type: object
    MultiseriesNamesControllerResponse:
      properties:
        count:
          description: The total number of series items in the response.
          type: integer
        data:
          $ref: '#/components/schemas/MultiseriesNamesControllerDataRecord'
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
        totalSeriesCount:
          description: The 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: The 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: The 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'
          type: array
      required:
      - datetimePartitionColumn
      - detectedMultiseriesIdColumns
      type: object
    MutualTLSSecurityScheme:
      properties:
        description:
          description: A description of the mTLS security scheme.
          type:
          - string
          - 'null'
        type:
          default: mutualTLS
          description: The security scheme type; must be 'mutualTLS'.
          enum:
          - mutualTLS
          type: string
      type: object
      x-versionadded: v2.46
    NemoConfigurationResponse:
      description: API response object for a playground Nemo configuration.
      properties:
        blockedTermsFileContents:
          description: The contents of the blocked terms file.
          title: blockedTermsFileContents
          type: string
        promptLlmConfiguration:
          anyOf:
          - $ref: '#/components/schemas/NemoLLMConfiguration'
          - type: 'null'
          description: The LLM configuration for the prompt pipeline.
        promptModerationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration for the prompt pipeline.
        promptPipelineFiles:
          anyOf:
          - $ref: '#/components/schemas/NemoPipelineFiles'
          - type: 'null'
          description: The prompt pipeline files for this configuration.
        promptPipelineMetricName:
          anyOf:
          - type: string
          - type: 'null'
          description: Name for the NeMo Prompt pipeline metric.
          title: promptPipelineMetricName
        promptPipelineTemplateId:
          anyOf:
          - type: string
          - type: 'null'
          description: Guard template to be used for the prompt pipeline, defines
            actions.py.
          title: promptPipelineTemplateId
        responseLlmConfiguration:
          anyOf:
          - $ref: '#/components/schemas/NemoLLMConfiguration'
          - type: 'null'
          description: The LLM configuration for the response pipeline.
        responseModerationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration for the response pipeline.
        responsePipelineFiles:
          anyOf:
          - $ref: '#/components/schemas/NemoPipelineFiles'
          - type: 'null'
          description: The response pipeline files for this configuration.
        responsePipelineMetricName:
          anyOf:
          - type: string
          - type: 'null'
          description: Name for the NeMo Response pipeline metric.
          title: responsePipelineMetricName
        responsePipelineTemplateId:
          anyOf:
          - type: string
          - type: 'null'
          description: Guard template to be used for the response pipeline, defines
            actions.py.
          title: responsePipelineTemplateId
      required:
      - promptPipelineMetricName
      - promptPipelineFiles
      - promptPipelineTemplateId
      - promptLlmConfiguration
      - responsePipelineMetricName
      - responsePipelineFiles
      - responsePipelineTemplateId
      - responseLlmConfiguration
      - blockedTermsFileContents
      title: NemoConfigurationResponse
      type: object
    NemoConfigurationUpsertRequest:
      description: The body of the Nemo Configuration upsert request.
      properties:
        blockedTermsFileContents:
          description: The contents of the blocked terms file.
          title: blockedTermsFileContents
          type: string
        promptLlmConfiguration:
          anyOf:
          - $ref: '#/components/schemas/NemoLLMConfiguration'
          - type: 'null'
          description: The LLM configuration for the prompt pipeline.
        promptModerationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration for the prompt pipeline.
        promptPipelineFiles:
          anyOf:
          - $ref: '#/components/schemas/NemoPiplineFilesRequest'
          - type: 'null'
          description: The prompt pipeline files for this configuration.
        promptPipelineMetricName:
          anyOf:
          - type: string
          - type: 'null'
          description: Name for the NeMo Prompt pipeline metric.
          title: promptPipelineMetricName
        promptPipelineTemplateId:
          anyOf:
          - type: string
          - type: 'null'
          description: Guard template to be used for the prompt pipeline, defines
            actions.py.
          title: promptPipelineTemplateId
        responseLlmConfiguration:
          anyOf:
          - $ref: '#/components/schemas/NemoLLMConfiguration'
          - type: 'null'
          description: The LLM configuration for the response pipeline.
        responseModerationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration for the response pipeline.
        responsePipelineFiles:
          anyOf:
          - $ref: '#/components/schemas/NemoPiplineFilesRequest'
          - type: 'null'
          description: The response pipeline files for this configuration.
        responsePipelineMetricName:
          anyOf:
          - type: string
          - type: 'null'
          description: Name for the NeMo Response pipeline metric.
          title: responsePipelineMetricName
        responsePipelineTemplateId:
          anyOf:
          - type: string
          - type: 'null'
          description: Guard template to be used for the response pipeline, defines
            actions.py.
          title: responsePipelineTemplateId
      required:
      - blockedTermsFileContents
      title: NemoConfigurationUpsertRequest
      type: object
    NemoLLMConfiguration:
      description: Configuration of LLM used for NeMo guardrails.
      properties:
        llmType:
          $ref: '#/components/schemas/LLMType'
        openaiApiBase:
          anyOf:
          - type: string
          - type: 'null'
          description: Azure OpenAI API base.
          title: openaiApiBase
        openaiApiDeploymentId:
          anyOf:
          - type: string
          - type: 'null'
          description: Azure OpenAI API deployment ID.
          title: openaiApiDeploymentId
        openaiApiKeyId:
          anyOf:
          - type: string
          - type: 'null'
          description: OpenAI API Key.
          title: openaiApiKeyId
      required:
      - llmType
      title: NemoLLMConfiguration
      type: object
    NemoPipelineFiles:
      description: Files used to setup a NeMo pipeline.
      properties:
        actionsFileContents:
          description: Contents of actions.py file.
          title: actionsFileContents
          type: string
        configYamlFileContents:
          description: Contents of config.yaml file.
          title: configYamlFileContents
          type: string
        flowDefinitionFileContents:
          description: Contents of flows.co file.
          title: flowDefinitionFileContents
          type: string
        promptsFileContents:
          description: Contents of prompts.yaml file.
          title: promptsFileContents
          type: string
      required:
      - actionsFileContents
      - configYamlFileContents
      - flowDefinitionFileContents
      - promptsFileContents
      title: NemoPipelineFiles
      type: object
    NemoPiplineFilesRequest:
      description: All of the files except for the actions.py file.
      properties:
        configYamlFileContents:
          description: The contents of the config.yaml file.
          title: configYamlFileContents
          type: string
        flowDefinitionFileContents:
          description: The contents of the flow definition file.
          title: flowDefinitionFileContents
          type: string
        promptsFileContents:
          description: The contents of the prompts file.
          title: promptsFileContents
          type: string
      required:
      - configYamlFileContents
      - flowDefinitionFileContents
      - promptsFileContents
      title: NemoPiplineFilesRequest
      type: object
    NewEnvironmentVariableSchema:
      description: Schema for updating environment variables.
      properties:
        description:
          description: The description of the environment variable.
          maxLength: 500
          title: Description
          type: string
        name:
          description: The name of the environment variable.
          maxLength: 253
          pattern: ^[a-zA-Z_$][\w$]*$
          title: Name
          type: string
        value:
          description: The value of the environment variable.
          maxLength: 131072
          title: Value
          type: string
      required:
      - name
      - value
      title: NewEnvironmentVariableSchema
      type: object
    NewNotebookFileSchema:
      description: The schema for the newly created notebook.
      properties:
        cells:
          description: List of cells in the notebook.
          items:
            anyOf:
            - $ref: '#/components/schemas/CodeCellSchema'
            - $ref: '#/components/schemas/MarkdownCellSchema'
            - $ref: '#/components/schemas/AnyCellSchema'
          title: Cells
          type: array
        metadata:
          description: Metadata for the notebook.
          title: Metadata
          type: object
        name:
          description: Name of the notebook.
          title: Name
          type: string
        nbformat:
          description: The notebook format version.
          title: Nbformat
          type: integer
        nbformatMinor:
          description: The notebook format minor version.
          title: Nbformatminor
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - name
      - path
      - nbformat
      - nbformatMinor
      - metadata
      title: NewNotebookFileSchema
      type: object
    NimArtifactSpec:
      additionalProperties: false
      properties:
        containerGroups:
          default: []
          description: List of container groups.
          items:
            $ref: '#/components/schemas/ContainerGroup'
          title: Containergroups
          type: array
        storage:
          anyOf:
          - $ref: '#/components/schemas/NimStorageConfig'
          - type: 'null'
          description: Model weight storage configuration. When omitted, defaults
            to a dedicated per-workload PVC provisioned exclusively for this workload.
        templateId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the template used to create this NIM Artifact
          title: Templateid
        type:
          const: nim
          default: nim
          description: "Artifact type discriminator. Injected automatically from the\
            \ top-level `type` field \u2014 do not set this directly."
          title: Type
          type: string
      title: NimArtifactSpec
      type: object
    NimStorageConfig:
      additionalProperties: false
      description: Model weight storage configuration for NIM artifacts.
      properties:
        mode:
          default: dedicatedPvc
          description: Storage mode for model weights. `dedicatedPvc` (default) provisions
            a separate PVC owned exclusively by this workload. `nimCache` reuses a
            single cluster-wide PVC per model image, shared across all workloads using
            the same model.
          enum:
          - dedicatedPvc
          - nimCache
          title: Mode
          type: string
        pvcSize:
          anyOf:
          - pattern: ^\d+(\.\d+)?(Gi|Mi|Ti)$
            type: string
          - type: 'null'
          description: PVC size for dedicated storage (e.g. '150Gi'). Only applies
            when mode is `dedicatedPvc`. When omitted, the platform-configured default
            is used.
          title: Pvcsize
      title: NimStorageConfig
      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
    NotebookActionSignature:
      description: Notebook action signature model that holds the information about
        when and who performed action on a notebook.
      properties:
        at:
          description: Timestamp of the action.
          format: date-time
          title: At
          type: string
        by:
          allOf:
          - $ref: '#/components/schemas/UserInfo'
          description: User info of the actor who performed the action.
          title: By
      required:
      - at
      - by
      title: NotebookActionSignature
      type: object
    NotebookActivityRequest:
      description: Request payload values for updating notebook activity.
      properties:
        paths:
          description: List of paths to update activity for.
          items:
            type: string
          title: Paths
          type: array
      title: NotebookActivityRequest
      type: object
    NotebookCellCommonSchema:
      description: Schema for notebook cell.
      properties:
        executed:
          allOf:
          - $ref: '#/components/schemas/NotebookTimestampInfo'
          description: The timestamp of when the cell was executed.
          title: Executed
        executionCount:
          description: The execution count of the cell relative to other cells in
            the current session.
          title: Executioncount
          type: integer
        executionTimeMillis:
          description: The execution time of the cell in milliseconds.
          title: Executiontimemillis
          type: integer
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: The metadata of the cell.
          title: Metadata
        outputType:
          allOf:
          - $ref: '#/components/schemas/OutputStorageType'
          default: RAW_OUTPUT
          description: The type of storage used for the cell output.
        outputs:
          description: The cell outputs.
          items:
            anyOf:
            - $ref: '#/components/schemas/APINotebookCellStreamOutput'
            - $ref: '#/components/schemas/APINotebookCellInputRequest'
            - $ref: '#/components/schemas/APINotebookCellErrorOutput'
            - $ref: '#/components/schemas/APINotebookCellExecuteResultOutput'
            - $ref: '#/components/schemas/APINotebookCellDisplayDataOutput'
          title: Outputs
          type: array
        source:
          description: The contents of the cell, represented as a string.
          title: Source
          type: string
      required:
      - source
      - metadata
      title: NotebookCellCommonSchema
      type: object
    NotebookCellDataRobotMetadata:
      description: A custom namespaces for all DataRobot-specific information
      properties:
        chartSettings:
          allOf:
          - $ref: '#/components/schemas/NotebookChartCellMetadata'
          description: Chart cell view options and metadata.
          title: Chartsettings
        customLlmMetricSettings:
          allOf:
          - $ref: '#/components/schemas/NotebookCustomLlmMetricCellMetadata'
          description: Custom LLM metric cell metadata.
          title: Customllmmetricsettings
        customMetricSettings:
          allOf:
          - $ref: '#/components/schemas/NotebookCustomMetricCellMetadata'
          description: Custom metric cell metadata.
          title: Custommetricsettings
        dataframeViewOptions:
          description: DataFrame view options and metadata.
          title: Dataframeviewoptions
          type: object
        disableRun:
          default: false
          description: Whether to disable the run button in the cell.
          title: Disablerun
          type: boolean
        executionTimeMillis:
          description: Execution time of the cell in milliseconds.
          title: Executiontimemillis
          type: integer
        hideCode:
          default: false
          description: Whether to hide the code in the cell.
          title: Hidecode
          type: boolean
        hideResults:
          default: false
          description: Whether to hide the results in the cell.
          title: Hideresults
          type: boolean
        language:
          $ref: '#/components/schemas/Language'
          allOf:
          - $ref: '#/components/schemas/Language'
          description: Programming language of the notebook cell.
      title: NotebookCellDataRobotMetadata
      type: object
    NotebookCellExecData:
      properties:
        cellType:
          allOf:
          - $ref: '#/components/schemas/SupportedCellTypes'
          description: Type of the cell.
        id:
          description: ID of the cell.
          title: Id
          type: string
        source:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          description: Contents of the cell, represented as a string.
          title: Source
      required:
      - id
      - cellType
      - source
      title: NotebookCellExecData
      type: object
    NotebookCellMetadata:
      description: The schema for the notebook cell metadata.
      properties:
        chartSettings:
          allOf:
          - $ref: '#/components/schemas/NotebookChartCellMetadata'
          description: Chart cell view options and metadata.
          title: Chartsettings
        collapsed:
          default: false
          description: Whether the cell's output is collapsed/expanded.
          title: Collapsed
          type: boolean
        customLlmMetricSettings:
          allOf:
          - $ref: '#/components/schemas/NotebookCustomLlmMetricCellMetadata'
          description: Custom LLM metric cell metadata.
          title: Customllmmetricsettings
        customMetricSettings:
          allOf:
          - $ref: '#/components/schemas/NotebookCustomMetricCellMetadata'
          description: Custom metric cell metadata.
          title: Custommetricsettings
        dataframeViewOptions:
          description: Dataframe cell view options and metadata.
          title: Dataframeviewoptions
          type: object
        datarobot:
          allOf:
          - $ref: '#/components/schemas/NotebookCellDataRobotMetadata'
          description: Metadata specific to DataRobot's notebooks and notebook environment.
          title: Datarobot
        disableRun:
          default: false
          description: Whether or not the cell is disabled in the UI.
          title: Disablerun
          type: boolean
        hideCode:
          default: false
          description: Whether or not code is hidden in the UI.
          title: Hidecode
          type: boolean
        hideResults:
          default: false
          description: Whether or not results are hidden in the UI.
          title: Hideresults
          type: boolean
        jupyter:
          allOf:
          - $ref: '#/components/schemas/JupyterCellMetadata'
          description: Jupyter metadata.
          title: Jupyter
        name:
          description: Name of the notebook cell.
          title: Name
          type: string
        scrolled:
          anyOf:
          - type: boolean
          - enum:
            - auto
            type: string
          default: auto
          description: Whether the cell's output is scrolled, unscrolled, or autoscrolled.
          title: Scrolled
      title: NotebookCellMetadata
      type: object
    NotebookCellSource:
      description: Notebook cell source model.
      properties:
        cellId:
          description: The ID of the cell.
          title: Cellid
          type: string
        md5:
          description: The MD5 hash of the cell.
          title: Md5
          type: string
        source:
          description: Contents of the cell, represented as a string.
          title: Source
          type: string
      required:
      - cellId
      - source
      - md5
      title: NotebookCellSource
      type: object
    NotebookCellSourceMetadata:
      description: Metadata for the source of a notebook cell.
      properties:
        attachments:
          description: Cell attachments.
          title: Attachments
          type: object
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: Cell metadata.
          title: Metadata
        outputs:
          description: Cell outputs that conform to the nbformat-based NBX schema.
          items:
            anyOf:
            - $ref: '#/components/schemas/APINotebookCellStreamOutput'
            - $ref: '#/components/schemas/APINotebookCellInputRequest'
            - $ref: '#/components/schemas/APINotebookCellErrorOutput'
            - $ref: '#/components/schemas/APINotebookCellExecuteResultOutput'
            - $ref: '#/components/schemas/APINotebookCellDisplayDataOutput'
          title: Outputs
          type: array
        source:
          description: Contents of the cell, represented as a string.
          title: Source
          type: string
      required:
      - source
      title: NotebookCellSourceMetadata
      type: object
    NotebookCellsSchema:
      description: The schema for the notebook cells.
      properties:
        cells:
          description: List of cells in the notebook.
          items:
            anyOf:
            - $ref: '#/components/schemas/CodeCellSchema'
            - $ref: '#/components/schemas/MarkdownCellSchema'
            - $ref: '#/components/schemas/AnyCellSchema'
          title: Cells
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
      required:
      - generation
      - cells
      title: NotebookCellsSchema
      type: object
    NotebookChartCellAxis:
      description: Chart cell axis settings per axis.
      properties:
        x:
          $ref: '#/components/schemas/NotebookChartCellAxisSettings'
        y:
          $ref: '#/components/schemas/NotebookChartCellAxisSettings'
      title: NotebookChartCellAxis
      type: object
    NotebookChartCellAxisSettings:
      description: Chart cell axis settings.
      properties:
        aggregation:
          description: Aggregation function for the axis.
          title: Aggregation
          type: string
        color:
          description: Color for the axis.
          title: Color
          type: string
        hideGrid:
          default: false
          description: Whether to hide the grid lines on the axis.
          title: Hidegrid
          type: boolean
        hideInTooltip:
          default: false
          description: Whether to hide the axis in the tooltip.
          title: Hideintooltip
          type: boolean
        hideLabel:
          default: false
          description: Whether to hide the axis label.
          title: Hidelabel
          type: boolean
        key:
          description: Key for the axis.
          title: Key
          type: string
        label:
          description: Label for the axis.
          title: Label
          type: string
        position:
          description: Position of the axis.
          title: Position
          type: string
        showPointMarkers:
          default: false
          description: Whether to show point markers on the axis.
          title: Showpointmarkers
          type: boolean
      title: NotebookChartCellAxisSettings
      type: object
    NotebookChartCellMetadata:
      description: Chart cell metadata.
      properties:
        axis:
          allOf:
          - $ref: '#/components/schemas/NotebookChartCellAxis'
          description: Axis settings.
          title: Axis
        data:
          description: The data associated with the cell chart.
          title: Data
          type: object
        dataframeId:
          description: The ID of the dataframe associated with the cell chart.
          title: Dataframeid
          type: string
        viewOptions:
          allOf:
          - $ref: '#/components/schemas/NotebookChartCellViewOptions'
          description: Chart cell view options.
          title: Viewoptions
      title: NotebookChartCellMetadata
      type: object
    NotebookChartCellViewOptions:
      description: Chart cell view options.
      properties:
        chartType:
          description: Type of the chart.
          title: Charttype
          type: string
        showLegend:
          default: false
          description: Whether to show the chart legend.
          title: Showlegend
          type: boolean
        showTitle:
          default: false
          description: Whether to show the chart title.
          title: Showtitle
          type: boolean
        showTooltip:
          default: false
          description: Whether to show the chart tooltip.
          title: Showtooltip
          type: boolean
        title:
          description: Title of the chart.
          title: Title
          type: string
      title: NotebookChartCellViewOptions
      type: object
    NotebookCustomLlmMetricCellMetadata:
      description: Custom LLM metric cell metadata.
      properties:
        metricId:
          description: The ID of the custom LLM metric.
          title: Metricid
          type: string
        metricName:
          description: The name of the custom LLM metric.
          title: Metricname
          type: string
        playgroundId:
          description: The ID of the playground associated with the custom LLM metric.
          title: Playgroundid
          type: string
      required:
      - metricId
      - playgroundId
      - metricName
      title: NotebookCustomLlmMetricCellMetadata
      type: object
    NotebookCustomMetricCellMetadata:
      description: Custom metric cell metadata.
      properties:
        deploymentId:
          description: The ID of the deployment associated with the custom metric.
          title: Deploymentid
          type: string
        metricId:
          description: The ID of the custom metric.
          title: Metricid
          type: string
        metricName:
          description: The name of the custom metric.
          title: Metricname
          type: string
        schedule:
          allOf:
          - $ref: '#/components/schemas/Schedule'
          description: The schedule associated with the custom metric.
          title: Schedule
      required:
      - metricId
      - deploymentId
      title: NotebookCustomMetricCellMetadata
      type: object
    NotebookExecutionState:
      description: Notebook execution state model
      properties:
        executingCellId:
          description: The ID of the cell currently being executed.
          title: Executingcellid
          type: string
        executionFinishedAt:
          description: The time the execution finished. This is based on the finish
            time of the last cell.
          format: date-time
          title: Executionfinishedat
          type: string
        executionStartedAt:
          description: The time the execution started.
          format: date-time
          title: Executionstartedat
          type: string
        inputRequest:
          allOf:
          - $ref: '#/components/schemas/AwaitingInputState'
          description: The input request state of the cell.
          title: Inputrequest
        kernelId:
          description: The ID of the kernel used for execution.
          title: Kernelid
          type: string
        queuedCellIds:
          description: The IDs of the cells that are queued for execution.
          items:
            type: string
          title: Queuedcellids
          type: array
      title: NotebookExecutionState
      type: object
    NotebookExecutionStateSchema:
      description: The schema for the notebook execution state.
      properties:
        executionState:
          allOf:
          - $ref: '#/components/schemas/NotebookExecutionState'
          description: Execution state of the notebook.
          title: Executionstate
        kernel:
          allOf:
          - $ref: '#/components/schemas/KernelSchema'
          description: Kernel assigned to the notebook.
          title: Kernel
        kernelId:
          description: Kernel ID assigned to the notebook.
          title: Kernelid
          type: string
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      title: NotebookExecutionStateSchema
      type: object
    NotebookFileSchema:
      description: The schema for a .ipynb notebook as part of a Codespace.
      properties:
        cells:
          description: List of cells in the notebook.
          items:
            anyOf:
            - $ref: '#/components/schemas/CodeCellSchema'
            - $ref: '#/components/schemas/MarkdownCellSchema'
            - $ref: '#/components/schemas/AnyCellSchema'
          title: Cells
          type: array
        executionState:
          allOf:
          - $ref: '#/components/schemas/NotebookExecutionState'
          description: Execution state of the notebook.
          title: Executionstate
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        kernelId:
          description: Kernel ID assigned to the notebook.
          title: Kernelid
          type: string
        lastExecuted:
          allOf:
          - $ref: '#/components/schemas/NotebookActionSignature'
          description: Last executed information.
          title: Lastexecuted
        metadata:
          description: Metadata for the notebook.
          title: Metadata
          type: object
        name:
          description: Name of the notebook.
          title: Name
          type: string
        nbformat:
          description: The notebook format version.
          title: Nbformat
          type: integer
        nbformatMinor:
          description: The notebook format minor version.
          title: Nbformatminor
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - name
      - path
      - generation
      - nbformat
      - nbformatMinor
      - metadata
      title: NotebookFileSchema
      type: object
    NotebookOperationQuery:
      description: Base query schema for notebook operations.
      properties:
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      title: NotebookOperationQuery
      type: object
    NotebookOperationSchema:
      description: Base schema for notebook operations.
      properties:
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      title: NotebookOperationSchema
      type: object
    NotebookPermission:
      description: The possible allowed actions for the current user for a given Notebook.
      enum:
      - CAN_READ
      - CAN_UPDATE
      - CAN_DELETE
      - CAN_SHARE
      - CAN_COPY
      - CAN_EXECUTE
      title: NotebookPermission
      type: string
    NotebookRevisionSchema:
      description: Notebook revision schema.
      properties:
        created:
          allOf:
          - $ref: '#/components/schemas/RevisionActionSchema'
          description: Revision creation action information.
          title: Created
        isAuto:
          description: Whether the revision was autosaved.
          title: Isauto
          type: boolean
        name:
          description: Revision name.
          title: Name
          type: string
        notebookId:
          description: Notebook ID this revision belongs to.
          title: Notebookid
          type: string
        revisionId:
          description: Revision ID.
          title: Revisionid
          type: string
        updated:
          allOf:
          - $ref: '#/components/schemas/RevisionActionSchema'
          description: Revision update action information.
          title: Updated
      required:
      - revisionId
      - notebookId
      - name
      - isAuto
      - created
      title: NotebookRevisionSchema
      type: object
    NotebookScheduleDefinition:
      description: Notebook schedule definition.
      properties:
        createdBy:
          allOf:
          - $ref: '#/components/schemas/UserInfo'
          description: User who created the job.
          title: Createdby
        enabled:
          description: Whether the job is enabled.
          title: Enabled
          type: boolean
        id:
          description: The ID of the scheduled job.
          title: Id
          type: string
        isNotebookRunning:
          default: false
          description: Whether or not the notebook is currently running (including
            manual runs). This accounts for notebook_path in Codespaces.
          title: Isnotebookrunning
          type: boolean
        jobPayload:
          allOf:
          - $ref: '#/components/schemas/ScheduledJobPayload'
          description: The payload for the job.
          title: Jobpayload
        lastFailedRun:
          description: Last failed run time of the job.
          format: date-time
          title: Lastfailedrun
          type: string
        lastRunTime:
          description: Calculated last run time (if it has run) by considering both
            failed and successful.
          format: date-time
          title: Lastruntime
          type: string
        lastSuccessfulRun:
          description: Last successful run time of the job.
          format: date-time
          title: Lastsuccessfulrun
          type: string
        nextRunTime:
          description: Next run time of the job.
          format: date-time
          title: Nextruntime
          type: string
        notebook:
          allOf:
          - $ref: '#/components/schemas/NotebookSupplementalMetadata'
          description: Notebook metadata.
          title: Notebook
        notebookHasEnabledSchedule:
          default: false
          description: Whether or not the notebook for this schedule has an enabled
            schedule - includes other schedules.
          title: Notebookhasenabledschedule
          type: boolean
        notebookType:
          $ref: '#/components/schemas/NotebookType'
        permissions:
          items:
            $ref: '#/components/schemas/NotebookPermission'
          type: array
        runType:
          $ref: '#/components/schemas/RunTypes'
        schedule:
          description: Cron-like string to define how frequently job should be run.
          title: Schedule
          type: string
        scheduleLocalized:
          description: Human-readable string calculated from the cron string that
            is translated and localized.
          title: Schedulelocalized
          type: string
        title:
          description: Human readable name for the job that a user can create and
            update.
          title: Title
          type: string
        userId:
          description: The ID of the user who created the job.
          title: Userid
          type: string
      required:
      - id
      - enabled
      - userId
      - jobPayload
      title: NotebookScheduleDefinition
      type: object
    NotebookScheduleJobsPaginated:
      description: Paginated response for notebook schedule jobs.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of notebook schedule jobs.
          items:
            $ref: '#/components/schemas/NotebookScheduleDefinition'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
        totalEnabledCount:
          description: Total number of enabled schedule jobs.
          title: Totalenabledcount
          type: integer
      required:
      - totalEnabledCount
      title: NotebookScheduleJobsPaginated
      type: object
    NotebookScheduledRun:
      description: Notebook scheduled run.
      properties:
        createdAt:
          description: The time the job was created.
          format: date-time
          title: Createdat
          type: string
        duration:
          description: The duration of the job in seconds.
          title: Duration
          type: integer
        endTime:
          description: The time the job ended.
          format: date-time
          title: Endtime
          type: string
        endTimeTs:
          description: The time the job ended.
          format: date-time
          title: Endtimets
          type: string
        environment:
          allOf:
          - $ref: '#/components/schemas/EnvironmentSupplementalMetadata'
          description: Environment metadata.
          title: Environment
        id:
          description: The ID of the job run.
          title: Id
          type: string
        jobAbortedTs:
          description: The time the job was aborted.
          format: date-time
          title: Jobabortedts
          type: string
        jobCompletedTs:
          description: The time the job completed.
          format: date-time
          title: Jobcompletedts
          type: string
        jobCreatedBy:
          allOf:
          - $ref: '#/components/schemas/UserInfo'
          description: User who created the job.
          title: Jobcreatedby
        jobErrorTs:
          description: The time the job errored.
          format: date-time
          title: Joberrorts
          type: string
        jobStartedTs:
          description: The time the job started.
          format: date-time
          title: Jobstartedts
          type: string
        notebook:
          allOf:
          - $ref: '#/components/schemas/NotebookSupplementalMetadata'
          description: Notebook metadata.
          title: Notebook
        notebookDeleted:
          default: false
          description: Whether the notebook was deleted.
          title: Notebookdeleted
          type: boolean
        notebookEnvironmentId:
          description: The ID of the notebook environment.
          title: Notebookenvironmentid
          type: string
        notebookEnvironmentImageId:
          description: The ID of the notebook environment image.
          title: Notebookenvironmentimageid
          type: string
        notebookEnvironmentLabel:
          description: The label of the notebook environment.
          title: Notebookenvironmentlabel
          type: string
        notebookEnvironmentName:
          description: The name of the notebook environment.
          title: Notebookenvironmentname
          type: string
        notebookHadErrors:
          default: false
          description: Whether the notebook had errors.
          title: Notebookhaderrors
          type: boolean
        notebookId:
          description: The ID of the notebook associated with the run.
          title: Notebookid
          type: string
        notebookName:
          description: The name of the notebook associated with the run.
          title: Notebookname
          type: string
        notebookRevisionId:
          description: The ID of the notebook revision.
          title: Notebookrevisionid
          type: string
        notebookRevisionName:
          description: The name of the notebook revision.
          title: Notebookrevisionname
          type: string
        notebookRunType:
          allOf:
          - $ref: '#/components/schemas/RunTypes'
          description: The run type of the notebook.
        orgId:
          description: The ID of the organization the job is associated with.
          title: Orgid
          type: string
        payload:
          allOf:
          - $ref: '#/components/schemas/ScheduledJobPayload'
          description: The payload for the job.
          title: Payload
        revision:
          allOf:
          - $ref: '#/components/schemas/RevisionSupplementalMetadata'
          description: Revision metadata.
          title: Revision
        runType:
          allOf:
          - $ref: '#/components/schemas/RunTypes'
          description: The run type of the job.
        scheduledJobId:
          description: The ID of the scheduled job.
          title: Scheduledjobid
          type: string
        startTime:
          description: The time the job started.
          format: date-time
          title: Starttime
          type: string
        status:
          description: The status of the job.
          title: Status
          type: string
        title:
          description: The name of the schedule.
          title: Title
          type: string
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
        useCaseName:
          description: The name of the use case this notebook is associated with.
          title: Usecasename
          type: string
        userId:
          description: The ID of the user who created the job.
          title: Userid
          type: string
      required:
      - id
      - createdAt
      - useCaseId
      - userId
      - orgId
      - notebookId
      - scheduledJobId
      - title
      - status
      - payload
      - notebookName
      - notebookRunType
      title: NotebookScheduledRun
      type: object
    NotebookScheduledRunsHistoryPaginated:
      description: Paginated response for notebook scheduled runs history.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of notebook scheduled runs history.
          items:
            $ref: '#/components/schemas/NotebookScheduledRun'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: NotebookScheduledRunsHistoryPaginated
      type: object
    NotebookSchema:
      description: Schema for notebook metadata with additional fields.
      properties:
        created:
          allOf:
          - $ref: '#/components/schemas/NotebookActionSignature'
          description: Information about the creation of the notebook.
          title: Created
        description:
          description: The description of the notebook.
          title: Description
          type: string
        hasEnabledSchedule:
          description: Whether the notebook has an enabled schedule.
          title: Hasenabledschedule
          type: boolean
        hasSchedule:
          description: Whether the notebook has a schedule.
          title: Hasschedule
          type: boolean
        id:
          description: The ID of the notebook.
          title: Id
          type: string
        lastViewed:
          allOf:
          - $ref: '#/components/schemas/NotebookActionSignature'
          description: Information about the last viewed time of the notebook.
          title: Lastviewed
        name:
          description: The name of the notebook.
          title: Name
          type: string
        orgId:
          description: The ID of the organization associated with the notebook.
          title: Orgid
          type: string
        permissions:
          description: The permissions associated with the notebook.
          items:
            $ref: '#/components/schemas/NotebookPermission'
          type: array
        session:
          allOf:
          - $ref: '#/components/schemas/NotebookSessionSharedSchema'
          description: Information about the session associated with the notebook.
          title: Session
        settings:
          allOf:
          - $ref: '#/components/schemas/NotebookSettings'
          default:
            hide_cell_footers: false
            hide_cell_outputs: false
            hide_cell_titles: false
            highlight_whitespace: false
            show_line_numbers: false
            show_scrollers: false
          description: The settings of the notebook.
          title: Settings
        tags:
          description: The tags of the notebook.
          items:
            type: string
          title: Tags
          type: array
        tenantId:
          description: The tenant ID associated with the notebook.
          title: Tenantid
          type: string
        type:
          allOf:
          - $ref: '#/components/schemas/NotebookType'
          default: plain
          description: The type of the notebook.
        typeTransition:
          allOf:
          - $ref: '#/components/schemas/NotebookTypeTransition'
          description: The type transition of the notebook.
        updated:
          allOf:
          - $ref: '#/components/schemas/NotebookActionSignature'
          description: Information about the last update of the notebook.
          title: Updated
        useCaseId:
          description: The ID of the Use Case associated with the notebook.
          title: Usecaseid
          type: string
        useCaseName:
          description: The name of the Use Case associated with the notebook.
          title: Usecasename
          type: string
      required:
      - name
      - id
      - created
      - lastViewed
      title: NotebookSchema
      type: object
    NotebookSessionSchema:
      description: The schema for the notebook session.
      properties:
        environment:
          allOf:
          - $ref: '#/components/schemas/EnvironmentPublic'
          description: The environment of the notebook session.
          title: Environment
        ephemeralSessionKey:
          allOf:
          - $ref: '#/components/schemas/EphemeralSessionKey'
          description: The key of the ephemeral session. None if not an ephemeral
            session.
          title: Ephemeralsessionkey
        executionCount:
          default: 0
          description: The execution count of the notebook session.
          title: Executioncount
          type: integer
        machineStatus:
          allOf:
          - $ref: '#/components/schemas/MachineStatuses'
          description: The status of the machine running the notebook session.
        notebookId:
          description: The ID of the notebook.
          title: Notebookid
          type: string
        parameters:
          description: Parameters to use as environment variables.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
        runnerStatus:
          allOf:
          - $ref: '#/components/schemas/RunnerStatuses'
          description: The status of the runner for the notebook session.
        sessionId:
          description: The ID of the notebook session.
          title: Sessionid
          type: string
        sessionType:
          allOf:
          - $ref: '#/components/schemas/SessionType'
          default: interactive
          description: The type of the notebook session. Possible values are interactive
            and triggered.
        startedAt:
          description: The time the notebook session was started.
          format: date-time
          title: Startedat
          type: string
        startedBy:
          allOf:
          - $ref: '#/components/schemas/NotebookUserSchema'
          description: The user who started the notebook session.
          title: Startedby
        status:
          allOf:
          - $ref: '#/components/schemas/NotebookSessionStatus'
          description: The status of the notebook session.
        userId:
          description: The ID of the user associated with the notebook session.
          title: Userid
          type: string
        withNetworkPolicy:
          description: Whether the session is created with network policies.
          title: Withnetworkpolicy
          type: boolean
      required:
      - status
      - notebookId
      - sessionId
      - environment
      - machineStatus
      - runnerStatus
      title: NotebookSessionSchema
      type: object
    NotebookSessionSharedSchema:
      description: The schema for the notebook session.
      properties:
        notebookId:
          description: The ID of the notebook.
          title: Notebookid
          type: string
        sessionType:
          allOf:
          - $ref: '#/components/schemas/SessionType'
          description: The type of the notebook session.
        startedAt:
          description: The time the notebook session was started.
          format: date-time
          title: Startedat
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/NotebookSessionStatus'
          description: The status of the notebook session.
        userId:
          description: The ID of the user associated with the notebook session.
          title: Userid
          type: string
      required:
      - status
      - notebookId
      title: NotebookSessionSharedSchema
      type: object
    NotebookSessionStatus:
      description: Possible overall states of a notebook session.
      enum:
      - stopping
      - stopped
      - starting
      - running
      - restarting
      - dead
      - deleted
      title: NotebookSessionStatus
      type: string
    NotebookSettings:
      description: Notebook UI settings.
      properties:
        hideCellFooters:
          default: false
          description: Whether or not cell footers are hidden in the UI.
          title: Hidecellfooters
          type: boolean
        hideCellOutputs:
          default: false
          description: Whether or not cell outputs are hidden in the UI.
          title: Hidecelloutputs
          type: boolean
        hideCellTitles:
          default: false
          description: Whether or not cell titles are hidden in the UI.
          title: Hidecelltitles
          type: boolean
        highlightWhitespace:
          default: false
          description: Whether or whitespace is highlighted in the UI.
          title: Highlightwhitespace
          type: boolean
        showLineNumbers:
          default: false
          description: Whether or not line numbers are shown in the UI.
          title: Showlinenumbers
          type: boolean
        showScrollers:
          default: false
          description: Whether or not scroll bars are shown in the UI.
          title: Showscrollers
          type: boolean
      title: NotebookSettings
      type: object
    NotebookSharedRole:
      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 recipient type.
          enum:
          - user
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.35
    NotebookSupplementalMetadata:
      description: Subset of metadata that is useful for display purposes.
      properties:
        deleted:
          default: false
          description: Whether the notebook is deleted.
          title: Deleted
          type: boolean
        id:
          description: Notebook ID.
          title: Id
          type: string
        name:
          description: Notebook name.
          title: Name
          type: string
        sessionStatus:
          allOf:
          - $ref: '#/components/schemas/NotebookSessionStatus'
          description: Status of the notebook session.
        sessionType:
          allOf:
          - $ref: '#/components/schemas/SessionType'
          description: Type of the notebook session.
        useCaseId:
          description: Use case ID associated with the notebook.
          title: Usecaseid
          type: string
        useCaseName:
          description: Use case name associated with the notebook.
          title: Usecasename
          type: string
      required:
      - id
      - name
      title: NotebookSupplementalMetadata
      type: object
    NotebookTimestampInfo:
      description: Notebook usage info model that holds the information about when
        and who performed action on a notebook.
      properties:
        at:
          description: Timestamp of the action.
          format: date-time
          title: At
          type: string
        by:
          allOf:
          - $ref: '#/components/schemas/UserInfo'
          description: User info of the actor who caused the action to occur.
          title: By
      required:
      - at
      - by
      title: NotebookTimestampInfo
      type: object
    NotebookType:
      description: 'Notebook type can be ''plain'', meaning a notebook that is not
        part of a codespace or ''codespace'' for notebooks that

        are part of a codespace. ''Ephemeral'' notebooks are created for a codespace
        but do not persist after session

        shutdown.'
      enum:
      - plain
      - codespace
      - ephemeral
      title: NotebookType
      type: string
    NotebookTypeTransition:
      description: An enumeration.
      enum:
      - initiated_to_codespace
      - completed
      title: NotebookTypeTransition
      type: string
    NotebookUserSchema:
      description: Schema for notebook user.
      properties:
        activated:
          default: true
          description: Whether the user is activated.
          title: Activated
          type: boolean
        firstName:
          description: The first name of the user.
          title: Firstname
          type: string
        gravatarHash:
          description: The gravatar hash of the user.
          title: Gravatarhash
          type: string
        id:
          description: The ID of the user.
          title: Id
          type: string
        lastName:
          description: The last name of the user.
          title: Lastname
          type: string
        orgId:
          description: The ID of the organization the user belongs to.
          title: Orgid
          type: string
        permissions:
          allOf:
          - $ref: '#/components/schemas/UserFeatureFlags'
          description: The feature flags of the user.
          title: Permissions
        tenantPhase:
          description: The tenant phase of the user.
          title: Tenantphase
          type: string
        username:
          description: The username of the user.
          title: Username
          type: string
      required:
      - id
      title: NotebookUserSchema
      type: object
    NotebooksExecutionStateResponse:
      description: Response schema for the notebooks execution state.
      properties:
        states:
          description: List of notebooks execution states.
          items:
            $ref: '#/components/schemas/NotebookExecutionStateSchema'
          title: States
          type: array
      required:
      - states
      title: NotebooksExecutionStateResponse
      type: object
    NotebooksSharedRolesListResponse:
      properties:
        data:
          description: Roles data for multiple notebooks.
          items:
            $ref: '#/components/schemas/MultipleNotebooksSharedRole'
          maxItems: 100
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.35
    NotificationChannel:
      description: The notification channel information used to send the notification.
      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
          - 'null'
        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'
          maxItems: 100
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          type:
          - string
          - 'null'
        id:
          description: The ID of the notification channel.
          type: string
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type:
          - string
          - 'null'
        name:
          description: The name of the new notification channel.
          type: string
        orgId:
          description: The ID of the organization that the notification channel belongs
            to.
          type:
          - string
          - 'null'
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type:
          - string
          - 'null'
        secretToken:
          description: Secret token to be used for new notification channel.
          type:
          - string
          - 'null'
        uid:
          description: The identifier of the user who created the channel.
          type:
          - string
          - 'null'
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          type:
          - string
          - 'null'
        validateSsl:
          description: Whether to validate SSL for the notification channel.
          type:
          - boolean
          - 'null'
      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'
          maxItems: 100
          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
          type:
          - string
          - 'null'
        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'
          maxItems: 100
          type: array
        emailAddress:
          description: The email address to be used in the new notification channel.
          type:
          - string
          - 'null'
        id:
          description: The ID of the notification channel.
          type: string
        languageCode:
          description: The preferred language code.
          enum:
          - en
          - es_419
          - fr
          - ja
          - ko
          - ptBR
          type:
          - string
          - 'null'
        lastNotificationAt:
          description: The timestamp of the last notification sent to the channel.
          format: date-time
          type:
          - string
          - 'null'
        name:
          description: The name of the new notification channel.
          type: string
        orgId:
          description: The id of organization that notification channel belongs to.
          type:
          - string
          - 'null'
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type:
          - string
          - 'null'
        policyCount:
          description: The count of policies assigned to the channel.
          type: integer
        secretToken:
          description: Secret token to be used for new notification channel.
          type:
          - string
          - 'null'
        uid:
          description: The identifier of the user who created the channel.
          type:
          - string
          - 'null'
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          type:
          - string
          - 'null'
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type:
          - boolean
          - 'null'
      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: The type of the related entity template.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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'
          maxItems: 100
          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
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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: The type of the related entity.
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          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'
          x-versionadded: v2.33
        customHeaders:
          description: Custom headers and their values to be sent in the new notification
            channel.
          items:
            $ref: '#/components/schemas/CustomerHeader'
          maxItems: 100
          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
          type: array
          x-versionadded: v2.33
        emailAddress:
          description: The email address to be used in the new notification channel.
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        lastNotificationAt:
          description: The timestamp of the last notification sent to the channel.
          format: date-time
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        payloadUrl:
          description: The payload URL of the new notification channel.
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        policyCount:
          description: The count of policies assigned to the channel.
          type: integer
          x-versionadded: v2.33
        policyTemplatesCount:
          description: The count of policy templates assigned to the channel.
          type: integer
          x-versionadded: v2.33
        role:
          description: User role on entity.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        secretToken:
          description: Secret token to be used for new notification channel.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        uid:
          description: The identifier of the user who created the channel.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        updatedAt:
          description: The date when the channel was updated.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        validateSsl:
          description: Defines if  validate ssl or not in the notification channel.
          type:
          - boolean
          - 'null'
          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'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
          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'
          maxItems: 100
          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'
          maxItems: 100
          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
          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'
          maxItems: 1000
          type: array
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
        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 the organization that the 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 whether the admin entered the correct 6-digit
            verification code.
          type: boolean
      required:
      - status
      type: object
    NotificationEventListResponse:
      properties:
        eventGroups:
          description: The selectable event groups.
          items:
            $ref: '#/components/schemas/EventGroupResponse'
          type: array
        events:
          description: The selectable individual events.
          items:
            $ref: '#/components/schemas/EventResponse'
          type: array
      required:
      - eventGroups
      - events
      type: object
    NotificationLog:
      description: The notification log record.
      properties:
        channelId:
          description: The ID of the channel that was used to send the notification.
          type: string
        channelScope:
          description: The scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          type:
          - string
          - 'null'
        emailSubject:
          description: The email subject of the notification.
          type:
          - string
          - 'null'
        id:
          description: The ID of the notification log.
          type: string
        parentNotificationId:
          description: The ID of the parent notification.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        response:
          description: The response that was received after sending the notification.
          type:
          - string
          - 'null'
        retryCount:
          description: The number of attempts to send the notification.
          type:
          - integer
          - 'null'
        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: The scope of the channel.
          enum:
          - organization
          - Organization
          - ORGANIZATION
          - entity
          - Entity
          - ENTITY
          - template
          - Template
          - TEMPLATE
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        policyId:
          description: The ID of the policy that was used to send the notification.
          type: string
        request:
          $ref: '#/components/schemas/RequestNotification'
        response:
          $ref: '#/components/schemas/ResponseNotification'
        retryCount:
          description: The count of retries while sending the notification.
          type: integer
        status:
          description: The status of the notification.
          type:
          - string
          - 'null'
        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: The number of items returned on this page.
          type: integer
        data:
          description: The array of notification logs.
          items:
            $ref: '#/components/schemas/NotificationLogListDataResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of notifications.
          type: integer
      required:
      - 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'
          maxItems: 1000
          type: array
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
        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: Whether 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 triggers the notification.
          enum:
          - secure_config.all
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - file.created
          - file.registered
          - file.deleted
          - file.shared
          - comment.created
          - comment.updated
          - invite_job.completed
          - 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.humility_rule
          - 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_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.custom_model_deployment_secure_config_failure
          - 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_activation_failed
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.custom_model_deployment_deactivation_failed
          - 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.prediction_payload_parsing_failure
          - 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
          - model_deployments.deployment_inference_server_idle_stopped
          - model_deployments.deployment_inference_server_maintenance_started
          - 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
          - use_case.shared
          - 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
          - custom_job_run.success
          - custom_job_run.failed
          - custom_job_run.interrupted
          - custom_job_run.cancelled
          - 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
          - abstract
          - moderation.metric.creation_error
          - moderation.metric.reporting_error
          - moderation.model.moderation_started
          - moderation.model.moderation_completed
          - moderation.model.pre_score_phase_started
          - moderation.model.pre_score_phase_completed
          - moderation.model.post_score_phase_started
          - moderation.model.post_score_phase_completed
          - moderation.model.config_error
          - moderation.model.runtime_error
          - moderation.model.scoring_started
          - moderation.model.scoring_completed
          - moderation.model.scoring_error
          - scim.user_provision_failed
          - scim.group_provision_failed
          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: The list of notification policy mutes.
          items:
            $ref: '#/components/schemas/NotificationPolicyMuteResponse'
          maxItems: 100
          type: array
        next:
          description: The URL pointing to the next page (if null, there is no next
            page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page (if null, there is no
            previous page).
          format: uri
          type:
          - string
          - 'null'
        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'
        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
          type:
          - string
          - 'null'
        eventGroup:
          $ref: '#/components/schemas/EventGroup'
        eventType:
          $ref: '#/components/schemas/EventType'
        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
          type:
          - string
          - 'null'
        name:
          description: The name of the notification policy.
          type: string
        orgId:
          description: The ID of the organization that owns the notification policy.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      required:
      - active
      - channel
      - channelId
      - created
      - eventGroup
      - eventType
      - id
      - lastTriggered
      - name
      - orgId
      - uid
      - updatedAt
      type: object
    NotificationPolicyUpdate:
      properties:
        active:
          description: Whether 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 triggers the notification.
          enum:
          - secure_config.all
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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
          - dataset.created
          - dataset.registered
          - dataset.deleted
          - datasets.deleted
          - datasetrelationship.created
          - dataset.shared
          - datasets.shared
          - file.created
          - file.registered
          - file.deleted
          - file.shared
          - comment.created
          - comment.updated
          - invite_job.completed
          - 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.humility_rule
          - 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_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.custom_model_deployment_secure_config_failure
          - 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_activation_failed
          - model_deployments.custom_model_deployment_deactivated
          - model_deployments.custom_model_deployment_deactivation_failed
          - 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.prediction_payload_parsing_failure
          - 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
          - model_deployments.deployment_inference_server_idle_stopped
          - model_deployments.deployment_inference_server_maintenance_started
          - 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
          - use_case.shared
          - 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
          - custom_job_run.success
          - custom_job_run.failed
          - custom_job_run.interrupted
          - custom_job_run.cancelled
          - 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
          - abstract
          - moderation.metric.creation_error
          - moderation.metric.reporting_error
          - moderation.model.moderation_started
          - moderation.model.moderation_completed
          - moderation.model.pre_score_phase_started
          - moderation.model.pre_score_phase_completed
          - moderation.model.post_score_phase_started
          - moderation.model.post_score_phase_completed
          - moderation.model.config_error
          - moderation.model.runtime_error
          - moderation.model.scoring_started
          - moderation.model.scoring_completed
          - moderation.model.scoring_error
          - scim.user_provision_failed
          - scim.group_provision_failed
          type: string
        name:
          description: The name of the notification policy.
          maxLength: 100
          type: string
      type: object
    NotificationResend:
      properties:
        notificationId:
          description: The ID of the notification to resend.
          type: string
      required:
      - notificationId
      type: object
    NotificationWebhookChannelStatusResponse:
      properties:
        notificationLog:
          $ref: '#/components/schemas/NotificationLog'
        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'
          maxItems: 100
          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 ID of the notification.
          type: string
      required:
      - notificationId
      type: object
    NotifyStatus:
      description: User notification values.
      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
          type:
          - string
          - 'null'
      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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        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
    OAuth2SecurityScheme:
      properties:
        description:
          description: A description of the OAuth 2.0 security scheme.
          type:
          - string
          - 'null'
        flows:
          $ref: '#/components/schemas/OAuthFlows'
        oauth2MetadataUrl:
          description: URL of the OAuth 2.0 server metadata document.
          type:
          - string
          - 'null'
        type:
          default: oauth2
          description: The security scheme type; must be 'oauth2'.
          enum:
          - oauth2
          type: string
      required:
      - flows
      type: object
      x-versionadded: v2.46
    OAuthCredentialsFields:
      properties:
        credentialType:
          description: The type of these credentials, 'oauth' here.
          enum:
          - oauth
          type: string
        oauthAccessToken:
          default: null
          description: The OAuth access token.
          type:
          - string
          - 'null'
        oauthClientId:
          default: null
          description: The OAuth client ID.
          type:
          - string
          - 'null'
        oauthClientSecret:
          default: null
          description: The OAuth client secret.
          type:
          - string
          - 'null'
        oauthRefreshToken:
          description: The OAuth refresh token.
          type: string
      required:
      - credentialType
      - oauthRefreshToken
      type: object
      x-versionadded: v2.46
    OAuthFlows:
      description: The supported OAuth 2.0 flows.
      properties:
        authorizationCode:
          $ref: '#/components/schemas/AuthorizationCodeOAuthFlow'
        clientCredentials:
          $ref: '#/components/schemas/ClientCredentialsOAuthFlow'
        implicit:
          $ref: '#/components/schemas/ImplicitOAuthFlow'
        password:
          $ref: '#/components/schemas/PasswordOAuthFlow'
      type: object
      x-versionadded: v2.46
    OCRJobCreationRequest:
      properties:
        datasetId:
          description: The OCR input dataset ID.
          type: string
        engineSpecificParameters:
          $ref: '#/components/schemas/OneOfEngineSpecificParametersInJobCreationRequest'
          x-versionadded: v2.38
        language:
          description: The supported OCR dataset language.
          enum:
          - ENGLISH
          - JAPANESE
          type: string
      required:
      - datasetId
      - language
      type: object
      x-versionadded: v2.35
    OCRJobErrorReportPutRequest:
      properties:
        file:
          description: The file to be uploaded
          format: binary
          type: string
      required:
      - file
      type: object
      x-versionadded: v2.35
    OCRJobPostPayload:
      type: object
      x-versionadded: v2.35
    OCRJobPostResponse:
      properties:
        errorReportLocation:
          description: The URL to retrieve the OCR job error report.
          format: uri
          type: string
        jobStatusLocation:
          description: The URL to retrieve the OCR job status.
          format: uri
          type: string
        outputLocation:
          description: The URL to retrieve the OCR job output.
          format: uri
          type: string
      required:
      - errorReportLocation
      - jobStatusLocation
      - outputLocation
      type: object
      x-versionadded: v2.35
    OCRJobResourceListResponse:
      properties:
        count:
          description: The number of records on this page.
          type: integer
        data:
          description: The list of OCR job resources.
          items:
            $ref: '#/components/schemas/OCRJobResourceResponse'
          maxItems: 1000
          type: array
        next:
          description: URL to the next page, or `null` if there is no such page.
          type:
          - string
          - 'null'
        previous:
          description: URL to the previous page, or `null` if there is no such page.
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.35
    OCRJobResourceResponse:
      properties:
        engineSpecificParameters:
          $ref: '#/components/schemas/OneOfEngineSpecificParametersInJobResourceResponse'
          default: null
          x-versionadded: v2.38
        id:
          description: The OCR job resource ID.
          type: string
        inputCatalogId:
          description: The OCR input dataset catalog ID.
          type: string
        jobStarted:
          description: Whether the job has started.
          type: boolean
        language:
          description: The supported OCR dataset language.
          enum:
          - ENGLISH
          - JAPANESE
          type: string
        outputCatalogId:
          description: The OCR output dataset catalog ID.
          type: string
        userId:
          description: The user ID.
          type: string
      required:
      - id
      - inputCatalogId
      - jobStarted
      - language
      - outputCatalogId
      - userId
      type: object
      x-versionadded: v2.35
    OCRJobStatusesResponse:
      properties:
        jobStatus:
          description: The status of general progress of OCR job resource creation.
          enum:
          - executing
          - failure
          - pending
          - stopped
          - success
          - unknown
          type: string
      required:
      - jobStatus
      type: object
      x-versionadded: v2.35
    OOTBAgenticMetricInsightNames:
      description: The Out-Of-The-Box metric name that can be used in an Agentic playground.
      enum:
      - tool_call_accuracy
      - agent_goal_accuracy_with_reference
      title: OOTBAgenticMetricInsightNames
      type: string
    OOTBDataset:
      description: Out-of-the-box dataset.
      properties:
        datasetName:
          $ref: '#/components/schemas/OOTBDatasetName'
          description: The name of the evaluation dataset.
        datasetUrl:
          anyOf:
          - $ref: '#/components/schemas/OOTBDatasetUrl'
          - type: 'null'
          description: The public URL of the evaluation dataset. This applies only
            to our predefined public evaluation datasets.
        promptColumnName:
          description: The name of the prompt column.
          maxLength: 5000
          minLength: 1
          title: promptColumnName
          type: string
        responseColumnName:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: The name of the response column, if present.
          title: responseColumnName
        rowsCount:
          description: The number rows in the dataset.
          title: rowsCount
          type: integer
        warning:
          anyOf:
          - type: string
          - type: 'null'
          description: Warning about the content of the dataset.
          title: warning
      required:
      - datasetName
      - datasetUrl
      - promptColumnName
      - responseColumnName
      - rowsCount
      title: OOTBDataset
      type: object
    OOTBDatasetName:
      description: Out-of-the-box dataset name.
      enum:
      - jailbreak-v1.csv
      - bbq-lite-age-v1.csv
      - bbq-lite-gender-v1.csv
      - bbq-lite-race-ethnicity-v1.csv
      - bbq-lite-religion-v1.csv
      - bbq-lite-disability-status-v1.csv
      - bbq-lite-sexual-orientation-v1.csv
      - bbq-lite-nationality-v1.csv
      - bbq-lite-ses-v1.csv
      - completeness-parent-v1.csv
      - completeness-grandparent-v1.csv
      - completeness-great-grandparent-v1.csv
      - pii-v1.csv
      - toxicity-v2.csv
      - jbbq-age-v1.csv
      - jbbq-gender-identity-v1.csv
      - jbbq-physical-appearance-v1.csv
      - jbbq-disability-status-v1.csv
      - jbbq-sexual-orientation-v1.csv
      title: OOTBDatasetName
      type: string
    OOTBDatasetUrl:
      description: Out-of-the-box dataset URL.
      enum:
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/jailbreak-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-age-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-gender-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-race-ethnicity-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-religion-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-disability-status-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-sexual-orientation-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-nationality-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/bbq-lite-ses-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/completeness-parent-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/completeness-grandparent-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/completeness-great-grandparent-v1.csv
      - https://s3.amazonaws.com/datarobot_public_datasets/genai/pii-v1.csv
      title: OOTBDatasetUrl
      type: string
    OOTBMetricConfigurationRequest:
      description: API request object for a single OOTB metric configuration.
      properties:
        customModelLLMValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model LLM validation (if using a custom
            model LLM).
          title: customModelLLMValidationId
        customOotbMetricName:
          anyOf:
          - type: string
          - type: 'null'
          description: The custom OOTB metric name to be associated with the OOTB
            metric. Will default to OOTB metric name if not defined.
          title: customOotbMetricName
        extraMetricSettings:
          anyOf:
          - $ref: '#/components/schemas/ExtraMetricSettings'
          - type: 'null'
          description: Extra settings for the metric that do not reference other entities.
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM to use for `correctness` and `faithfulness`
            metrics.
          title: llmId
        moderationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration to be associated with the OOTB
            metric.
        ootbMetricName:
          anyOf:
          - $ref: '#/components/schemas/OOTBMetricInsightNames'
          - $ref: '#/components/schemas/OOTBAgenticMetricInsightNames'
          - $ref: '#/components/schemas/OTELMetricInsightNames'
          description: The OOTB metric name.
          title: ootbMetricName
      required:
      - ootbMetricName
      title: OOTBMetricConfigurationRequest
      type: object
    OOTBMetricConfigurationResponse:
      description: API response object for a single OOTB metric.
      properties:
        customModelLLMValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the custom model LLM validation (if using a custom
            model LLM).
          title: customModelLLMValidationId
        customOotbMetricName:
          anyOf:
          - type: string
          - type: 'null'
          description: The custom OOTB metric name to be associated with the OOTB
            metric.
          title: customOotbMetricName
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the OOTB metric configuration.
          title: errorMessage
        errorResolution:
          anyOf:
          - items:
              $ref: '#/components/schemas/InsightErrorResolution'
            type: array
          - type: 'null'
          description: The error type associated with the insight error status and
            error message as an indicator of what fields needs to be edited if any.
          title: errorResolution
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the OOTB metric configuration.
        extraMetricSettings:
          anyOf:
          - $ref: '#/components/schemas/ExtraMetricSettings'
          - type: 'null'
          description: Extra settings for the metric that do not reference other entities.
        isAgentic:
          default: false
          description: Whether the OOTB metric configuration is specific to agentic
            workflows.
          title: isAgentic
          type: boolean
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the LLM to use for `correctness` and `faithfulness`
            metrics.
          title: llmId
        moderationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration to be associated with the OOTB
            metric.
        ootbMetricConfigurationId:
          description: The ID of OOTB metric.
          title: ootbMetricConfigurationId
          type: string
        ootbMetricName:
          anyOf:
          - $ref: '#/components/schemas/OOTBMetricInsightNames'
          - $ref: '#/components/schemas/OOTBAgenticMetricInsightNames'
          - $ref: '#/components/schemas/OTELMetricInsightNames'
          description: The name of the OOTB metric.
          title: ootbMetricName
      required:
      - ootbMetricName
      - ootbMetricConfigurationId
      - executionStatus
      title: OOTBMetricConfigurationResponse
      type: object
    OOTBMetricConfigurationsResponse:
      description: The response for the "OOTB metric configurations" retrieve request.
      properties:
        ootbMetricConfigurations:
          description: The list of OOTB metric configurations to use.
          items:
            $ref: '#/components/schemas/OOTBMetricConfigurationResponse'
          title: ootbMetricConfigurations
          type: array
      required:
      - ootbMetricConfigurations
      title: OOTBMetricConfigurationsResponse
      type: object
    OOTBMetricInsightNames:
      description: The Out-Of-The-Box metric name that can be used in the playground.
      enum:
      - latency
      - citations
      - rouge_1
      - faithfulness
      - correctness
      - prompt_tokens
      - response_tokens
      - document_tokens
      - all_tokens
      - jailbreak_violation
      - toxicity_violation
      - pii_violation
      - exact_match
      - starts_with
      - contains
      title: OOTBMetricInsightNames
      type: string
    OTELMetricInsightNames:
      description: Metrics that can only be calculated using OTEL Trace/metric data.
      enum:
      - agent_latency
      - agent_tokens
      - agent_cost
      title: OTELMetricInsightNames
      type: string
    ObjectIdSettingConstraints:
      description: Available constraints for ObjectId settings.
      properties:
        allowedChoices:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The allowed values for the setting.
          title: allowedChoices
        type:
          const: object_id
          default: object_id
          description: The data type of the setting.
          title: type
          type: string
      title: ObjectIdSettingConstraints
      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'
          directive:
            description: The single data transformation step.
            enum:
            - filter
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/ReplaceDirectiveArguments'
          directive:
            description: The single data transformation step.
            enum:
            - replace
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/ComputeNewDirectiveArguments'
          directive:
            description: The single data transformation step.
            enum:
            - compute-new
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/BaseDirectiveArguments'
            default: {}
          directive:
            description: The single data transformation step.
            enum:
            - dedupe-rows
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/DropColumnsArguments'
          directive:
            description: The single data transformation step.
            enum:
            - drop-columns
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/RenameColumnsArguments'
          directive:
            description: The single data transformation step.
            enum:
            - rename-columns
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/JoinArguments'
          directive:
            description: The single data transformation step.
            enum:
            - join
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/AggregateDirectiveArguments'
          directive:
            description: The single data transformation step.
            enum:
            - aggregate
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/TimeSeriesDirectiveArguments'
          directive:
            description: Time series processing directive, which prepares the dataset
              for time series modeling. All windows are row-based.
            enum:
            - time-series
            type: string
        required:
        - arguments
        - directive
        type: object
    OneOfDownsamplingDirective:
      description: Data transformation step.
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/DownsamplingRandomDirectiveArguments'
          directive:
            description: The downsampling method.
            enum:
            - random-sample
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/SmartDownsamplingArguments'
          directive:
            description: The downsampling method.
            enum:
            - smart-downsampling
            type: string
        required:
        - arguments
        - directive
        type: object
    OneOfEngineSpecificParametersInJobCreationRequest:
      description: The OCR engine-specific parameters.
      discriminator:
        propertyName: engineType
      oneOf:
      - properties:
          engineType:
            description: The Aryn OCR engine.
            enum:
            - ARYN
            type: string
          outputFormat:
            default: JSON
            description: The output format of Aryn OCR.
            enum:
            - JSON
            - MARKDOWN
            type: string
        required:
        - engineType
        - outputFormat
        type: object
      - properties:
          engineType:
            description: The Tesseract OCR engine.
            enum:
            - TESSERACT
            type: string
        required:
        - engineType
        type: object
      x-versionadded: v2.38
    OneOfEngineSpecificParametersInJobResourceResponse:
      description: The OCR engine-specific parameters.
      discriminator:
        propertyName: engineType
      oneOf:
      - properties:
          engineType:
            description: The Aryn OCR engine.
            enum:
            - ARYN
            type: string
          outputFormat:
            default: JSON
            description: The output format of Aryn OCR.
            enum:
            - JSON
            - MARKDOWN
            type: string
        required:
        - engineType
        - outputFormat
        type: object
      - properties:
          engineType:
            description: The Tesseract OCR engine.
            enum:
            - TESSERACT
            type: string
        required:
        - engineType
        type: object
      x-versionadded: v2.38
    OneOfTransforms:
      discriminator:
        propertyName: name
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/BaseNumericStatsArguments'
          name:
            description: Task name.
            enum:
            - numeric-stats
            type: string
        required:
        - arguments
        - name
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/BaseCategoricalStatsArguments'
          name:
            description: Task name.
            enum:
            - categorical-stats
            type: string
        required:
        - arguments
        - name
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/BaseLagsArguments'
          name:
            description: Task name.
            enum:
            - lags
            type: string
        required:
        - arguments
        - name
        type: object
      x-versionadded: v2.35
    OpenIdConnectSecurityScheme:
      properties:
        description:
          description: A description of the OpenID Connect security scheme.
          type:
          - string
          - 'null'
        openIdConnectUrl:
          description: The OpenID Connect discovery document URL.
          type: string
        type:
          default: openIdConnect
          description: The security scheme type; must be 'openIdConnect'.
          enum:
          - openIdConnect
          type: string
      required:
      - openIdConnectUrl
      type: object
      x-versionadded: v2.46
    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
          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'
            - $ref: '#/components/schemas/BacktestNewMethodForOpenApi'
          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: The 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
          type:
          - string
          - 'null'
          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:
      description: Datetime partition information.
      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'
        target:
          description: The name of the target column.
          type: string
      required:
      - datetimePartitionColumn
      - id
      - partitionData
      - target
      type: object
    OptimizedDatetimePartitioningListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    OptionalDRConnectorV1DataSource:
      properties:
        dataStoreId:
          description: The data store ID for this data source.
          type: string
          x-versionadded: v2.22
        filter:
          description: An optional filter string for narrowing results, which overrides
            `path` when specified. Only supported by the Jira connector.
          maxLength: 320000
          type: string
          x-versionadded: v2.39
        path:
          description: The 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: The data store ID for this data source.
          type: string
        fetchSize:
          description: The 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: 320000
          type: string
      type: object
    OptionalDatabaseTableDataSource:
      properties:
        catalog:
          description: The catalog name in the database if supported.
          maxLength: 256
          type: string
        dataStoreId:
          description: The data store ID for this data source.
          type: string
        fetchSize:
          description: The 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: The schema associated with the table or view in the database
            if supported.
          maxLength: 256
          type: string
        table:
          description: The table or view name in the database.
          maxLength: 256
          type: string
      type: object
    OrderBy:
      description: Enum for ordering notebooks when querying.
      enum:
      - name
      - -name
      - created
      - -created
      - updated
      - -updated
      - tags
      - -tags
      - lastViewed
      - -lastViewed
      - useCaseName
      - -useCaseName
      - sessionStatus
      - -sessionStatus
      title: OrderBy
      type: string
    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: The number of items on the current page.
          type: integer
        data:
          description: The list of the requested jobs.
          items:
            $ref: '#/components/schemas/OrganizationJob'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page.
          format: uri
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    OrganizationListResponse:
      properties:
        count:
          description: The number of items on the current page.
          type: integer
        data:
          description: The list of the requested organizations.
          items:
            $ref: '#/components/schemas/OrganizationRetrieve'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          type:
          - string
          - 'null'
      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
        activeUsersCount:
          description: The number of active users for this organization. This excludes
            deactivated users, aliased DataRobot accounts (in SaaS), and users with
            NON_BUILDER_USER seat license.
          type: integer
          x-versionadded: v2.41
        agreementStatus:
          description: The status of the organization's agreement to the terms of
            DataRobot.
          enum:
          - NEEDED
          - AGREED
          - N/A
          type: string
        customAppAutoStopSeconds:
          description: Per-organization override for the cluster-default custom application
            auto-stop timeout (in seconds). When null, the cluster default is used.
          minimum: 1
          type:
          - integer
          - 'null'
          x-versionadded: v2.43
        datasetRefreshJobLimit:
          description: How many enabled dataset refresh jobs are allowed per-dataset
            for this organization.
          type:
          - integer
          - 'null'
        datasetRefreshJobUserLimit:
          description: How many enabled dataset refresh jobs are allowed per-user
            for this organization.
          type:
          - integer
          - 'null'
        defaultUserMaxGpuWorkers:
          description: Maximum number of concurrent GPU workers assigned to a newly
            created user of this organization.
          type:
          - integer
          - 'null'
        defaultUserMaxWorkers:
          description: Maximum number of concurrent workers assigned to a newly created
            user of this organization.
          type:
          - integer
          - 'null'
        deleted:
          description: Indicates whether the organization is soft-deleted.
          type:
          - boolean
          - 'null'
        deletedAt:
          description: Indicates when the organization was soft-deleted.
          format: date-time
          type:
          - string
          - 'null'
        deletedBy:
          description: Indicates who has soft-deleted the organization.
          type:
          - string
          - 'null'
        desiredCustomModelContainerSize:
          description: The desired custom-model memory size. This will only be present
            if the corresponding feature flag is set.
          maximum: 15032385536
          minimum: 134217728
          type:
          - integer
          - 'null'
        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
        maxCodespaceFileUploadSize:
          description: Maximum file upload size (MB) for Codespaces.
          maximum: 50000
          minimum: 10
          type:
          - integer
          - 'null'
          x-versionadded: v2.4
        maxCodespaces:
          description: Maximum number of codespaces available to this organization.
          type:
          - integer
          - 'null'
        maxComputeServerlessPredictionApi:
          description: The number of maximum allowed compute on a serverless platform
            for this organization
          minimum: 1
          type:
          - integer
          - 'null'
        maxConcurrentBatchPredictionsJob:
          description: Maximum number of concurrent batch prediction jobs to this
            organization
          maximum: 10
          minimum: 1
          type:
          - integer
          - 'null'
        maxConcurrentNotebooks:
          description: Maximum number of concurrent notebooks available to this organization.
          type:
          - integer
          - 'null'
        maxConcurrentWorkloads:
          description: The maximum number of concurrently running workloads for this
            organization. A value of zero means unlimited.
          minimum: 0
          type:
          - integer
          - 'null'
          x-versionadded: v2.46
        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
          type:
          - integer
          - 'null'
        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: 0
          maximum: 25
          type:
          - integer
          - 'null'
        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
          type:
          - integer
          - 'null'
        maxDailyBatchesPerDeployment:
          description: The maximum number of monitoring batches that can be created
            per day on deployments that belong to this organization.
          minimum: 1
          type:
          - integer
          - 'null'
        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.
          type:
          - integer
          - 'null'
        maxEnabledNotebookSchedules:
          description: Maximum number of enabled notebook schedules for this organization.
          minimum: 1
          type:
          - integer
          - 'null'
        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
          type:
          - integer
          - 'null'
        maxGpuWorkers:
          description: Maximum number of concurrent GPU workers available to this
            organization.
          type:
          - integer
          - 'null'
        maxLlmApiCalls:
          description: Maximum number of LLM calls.
          minimum: 1
          type:
          - integer
          - 'null'
        maxNotebookMachineSize:
          description: Maximum size of notebook machine available to this organization.
          enum:
          - L
          - M
          - S
          - XL
          - XS
          - XXL
          type:
          - string
          - 'null'
        maxNotebookSchedulingWorkers:
          description: Maximum number of concurrently running notebooks schedules
            for this organization.
          maximum: 20
          minimum: 1
          type:
          - integer
          - 'null'
        maxPipelineModuleRuntimes:
          description: Maximum number of Pipeline module runtimes available to this
            organization.
          type:
          - integer
          - 'null'
        maxUploadSize:
          description: Maximum size for file uploads (MB). This will only be present
            if the corresponding feature flag is set.
          type:
          - integer
          - 'null'
        maxUploadSizeCatalog:
          description: Maximum size for catalog file uploads (MB). This will only
            be present if the corresponding feature flag is set.
          type:
          - integer
          - 'null'
        maxVectorDatabases:
          description: Maximum number of local vector databases.
          minimum: 1
          type:
          - integer
          - 'null'
        maxWorkers:
          description: Maximum number of concurrent workers available to this organization.
          type:
          - integer
          - 'null'
        maxWorkloadReplicas:
          description: The maximum number of replicas per workload for this organization.
            A value of zero means unlimited.
          minimum: 0
          type:
          - integer
          - 'null'
          x-versionadded: v2.46
        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.
          type:
          - string
          - 'null'
        notebooksSoftDeletionRetentionPeriod:
          description: Retention window for soft-deleted notebooks and respective
            resources before NBX services hard-delete them.
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        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.
          type:
          - boolean
          - 'null'
        permadeletedAt:
          description: Indicates when the organization was permadeleted.
          format: date-time
          type:
          - string
          - 'null'
        permadeletedBy:
          description: Indicates who has permadeleted the organization.
          type:
          - string
          - 'null'
        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.
          type:
          - integer
          - 'null'
        supportEmail:
          description: The support email of the organization.
          type:
          - string
          - 'null'
      required:
      - activeUsersCount
      - 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
          maxItems: 100
          type: array
        create:
          default: false
          description: Whether to create the user if not found.
          type: boolean
        firstName:
          description: The 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: The 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: The ID of the user added to the organization.
          type: string
      type: object
    OrganizationUserListResponse:
      properties:
        count:
          description: The number of items on the current page.
          type: integer
        data:
          description: The list of users in the organization.
          items:
            $ref: '#/components/schemas/OrganizationUserResponse'
          maxItems: 1000
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page)
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page
          format: uri
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    OrganizationUserPatch:
      properties:
        accessRoleIds:
          description: The list of access role IDs assigned to the user.
          items:
            type: string
          maxItems: 100
          type: array
        activated:
          description: Whether the organization user is activated.
          type: boolean
        expirationDate:
          description: The user expiration date.
          format: date-time
          type: string
        maxWorkers:
          description: The user max workers.
          exclusiveMinimum: 0
          type: integer
        orgAdmin:
          description: Mark the 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: The list of access role IDs assigned to the user.
          items:
            type: string
          maxItems: 100
          type: array
        activated:
          description: Whether the organization user is activated.
          type: boolean
        expirationDate:
          description: User expiration date
          format: date-time
          type:
          - string
          - 'null'
        externalId:
          description: The external user ID.
          type: string
        firstName:
          description: The first name of the user being created.
          type:
          - string
          - 'null'
        id:
          description: The organization user identifier.
          type: string
        isAliasedDatarobotAccount:
          description: Determines whether or not the username uses aliasing in the
            email address for DataRobot accounts.
          type: boolean
          x-versionadded: v2.38
        lastName:
          description: The last name of the user being created.
          type:
          - string
          - 'null'
        maxConcurrentWorkloads:
          description: The maximum number of concurrently running workloads for this
            user. A value of zero means unlimited.
          type: integer
          x-versionadded: v2.46
        maxWorkers:
          description: Maximum number of concurrent workers available to this user.
          type: integer
        maxWorkloadReplicas:
          description: The maximum number of replicas per workload for this user.
            A value of zero means unlimited.
          type: integer
          x-versionadded: v2.46
        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
        scimIdpName:
          description: Name of the identity provider managing this user via SCIM (e.g.,
            `Okta`, `entra_id`). Null for non-SCIM-managed users.
          type:
          - string
          - 'null'
          x-versionadded: v2.46
        scimManaged:
          description: True when this user is provisioned and managed by an external
            identity provider via SCIM. SCIM-managed users have IdP-owned attributes
            that are read-only in DataRobot.
          type: boolean
          x-versionadded: v2.46
        username:
          description: The username of the user to add to the organization.
          type: string
      required:
      - activated
      - expirationDate
      - externalId
      - firstName
      - id
      - isAliasedDatarobotAccount
      - lastName
      - maxConcurrentWorkloads
      - maxWorkers
      - maxWorkloadReplicas
      - orgAdmin
      - organizationId
      - username
      type: object
    OrganizationsResponse:
      properties:
        id:
          description: The identifier of the organization
          type: string
        name:
          description: The name of the organization
          type: string
        tenantId:
          description: The identifier of the tenant
          type: string
      required:
      - id
      - name
      - tenantId
      type: object
      x-versionadded: v2.39
    OtelAutocollectedMetricValue:
      properties:
        aggregatedValue:
          description: The aggregated metric value over the period.
          type:
          - number
          - 'null'
        aggregation:
          description: The aggregation method used for metric display.
          type:
          - string
          - 'null'
        currentValue:
          description: The current metric value at request time.
          type:
          - number
          - 'null'
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        level:
          description: Indicates whether this metric is logged for an entity, a pod,
            or a container.
          enum:
          - entity
          - pod
          - container
          type: string
        maximumMetricOtelName:
          description: The name of a metric that indicates the maximum value for this
            metric.
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        unit:
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          type:
          - string
          - 'null'
      required:
      - level
      - otelName
      type: object
      x-versionadded: v2.39
    OtelContainerInfo:
      properties:
        name:
          description: The name of the container.
          type: string
      required:
      - name
      type: object
      x-versionadded: v2.46
    OtelLogEntry:
      properties:
        level:
          description: The log level.
          type: string
        message:
          description: The log message.
          type: string
        spanId:
          description: The OTel span ID with which the log is associated.
          type:
          - string
          - 'null'
          x-versionadded: v2.39
        stacktrace:
          description: The stack trace (if any).
          type: string
        timestamp:
          description: The log timestamp.
          format: date-time
          type: string
        traceId:
          description: The OTel trace ID with which the log is associated.
          type:
          - string
          - 'null'
          x-versionadded: v2.39
      required:
      - level
      - message
      - timestamp
      type: object
      x-versionadded: v2.39
    OtelLoggingListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of OpenTelemetry log entries.
          items:
            $ref: '#/components/schemas/OtelLogEntry'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.39
    OtelMetricAggregatedValue:
      properties:
        aggregatedValue:
          description: The aggregated metric value over the period.
          type:
          - number
          - 'null'
        aggregation:
          description: The aggregation method used for metric display.
          type:
          - string
          - 'null'
        buckets:
          description: The histogram bucket values.
          items:
            $ref: '#/components/schemas/OtelMetricHistogramBucketValue'
          maxItems: 100
          type: array
        currentValue:
          description: The current metric value at request time.
          type:
          - number
          - 'null'
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        unit:
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          type:
          - string
          - 'null'
      required:
      - otelName
      type: object
      x-versionadded: v2.41
    OtelMetricAggregatedValueSegmented:
      properties:
        aggregatedValues:
          description: The aggregated metric values segmented by attribute.
          items:
            type: number
          maxItems: 50
          type: array
        aggregation:
          description: The aggregation method used for metric display.
          type:
          - string
          - 'null'
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
      required:
      - otelName
      type: object
      x-versionadded: v2.4
    OtelMetricAggregatedValuesResponse:
      properties:
        endTime:
          description: The end time of the metric value period.
          format: date-time
          type: string
        metricAggregations:
          description: The list of OTel metric value periods.
          items:
            $ref: '#/components/schemas/OtelMetricAggregatedValue'
          maxItems: 100
          type: array
        startTime:
          description: The start time of the metric value period.
          format: date-time
          type: string
      required:
      - metricAggregations
      type: object
      x-versionadded: v2.41
    OtelMetricAggregatedValuesSegmentedResponse:
      properties:
        endTime:
          description: The end time of the metric value period.
          format: date-time
          type: string
        metricAggregations:
          description: The list of OTel metric value periods.
          items:
            $ref: '#/components/schemas/OtelMetricAggregatedValueSegmented'
          maxItems: 50
          type: array
        segment:
          $ref: '#/components/schemas/OtelMetricSegment'
        startTime:
          description: The start time of the metric value period.
          format: date-time
          type: string
      required:
      - endTime
      - metricAggregations
      - segment
      - startTime
      type: object
      x-versionadded: v2.4
    OtelMetricAttribute:
      properties:
        attributeName:
          description: The name of this attribute.
          maxLength: 255
          type: string
        attributeValue:
          description: The value of this attribute.
          maxLength: 255
          type: string
      required:
      - attributeName
      - attributeValue
      type: object
      x-versionadded: v2.39
    OtelMetricAttributeList:
      properties:
        attributes:
          description: The list of attribute name-value pairs.
          items:
            $ref: '#/components/schemas/OtelMetricAttribute'
          maxItems: 10
          type: array
      required:
      - attributes
      type: object
      x-versionadded: v2.39
    OtelMetricAttributeSegmentedValue:
      properties:
        endTime:
          description: The end time of the metric value period.
          format: date-time
          type: string
        startTime:
          description: The start time of the metric value period.
          format: date-time
          type: string
        value:
          description: The aggregated metric value over the period.
          type:
          - number
          - 'null'
      required:
      - endTime
      - startTime
      type: object
      x-versionadded: v2.39
    OtelMetricAttributeWithValuesList:
      properties:
        attributes:
          description: The list of attributes for this segment.
          items:
            $ref: '#/components/schemas/OtelMetricAttribute'
          maxItems: 1000
          type: array
        values:
          description: The time buckets with metric values for this segment.
          items:
            $ref: '#/components/schemas/OtelMetricAttributeSegmentedValue'
          maxItems: 1000
          type: array
      required:
      - attributes
      - values
      type: object
      x-versionadded: v2.39
    OtelMetricAutocollectedValuesResponse:
      properties:
        data:
          description: The list of automatically collected OTel metric values.
          items:
            $ref: '#/components/schemas/OtelAutocollectedMetricValue'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.39
    OtelMetricConfigCreatePayload:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          enum:
          - sum
          - average
          - min
          - max
          - cardinality
          - percentiles
          - histogram
          type: string
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        enabled:
          default: true
          description: Whether the OTel metric is enabled.
          type: boolean
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        percentile:
          description: The metric percentile for the percentile aggregation of histograms.
          exclusiveMinimum: 0.0
          maximum: 1.0
          type:
          - number
          - 'null'
        unit:
          default: null
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          - null
          type:
          - string
          - 'null'
      required:
      - otelName
      type: object
      x-versionadded: v2.41
    OtelMetricConfigListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of OpenTelemetry metrics.
          items:
            $ref: '#/components/schemas/OtelMetricConfigObject'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.41
    OtelMetricConfigObject:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          enum:
          - sum
          - average
          - min
          - max
          - cardinality
          - percentiles
          - histogram
          type: string
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        enabled:
          default: true
          description: Whether the OTel metric is enabled.
          type:
          - boolean
          - 'null'
        id:
          description: The ID of the metric.
          type: string
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        percentile:
          description: The metric percentile for the percentile aggregation of histograms.
          exclusiveMinimum: 0.0
          maximum: 1.0
          type:
          - number
          - 'null'
        unit:
          default: null
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          - null
          type:
          - string
          - 'null'
      required:
      - displayName
      - enabled
      - id
      - otelName
      type: object
      x-versionadded: v2.41
    OtelMetricConfigPayload:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          enum:
          - sum
          - average
          - min
          - max
          - cardinality
          - percentiles
          - histogram
          type: string
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        enabled:
          default: true
          description: Whether the OTel metric is enabled.
          type: boolean
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        percentile:
          description: The metric percentile for the percentile aggregation of histograms.
          exclusiveMinimum: 0.0
          maximum: 1.0
          type:
          - number
          - 'null'
        unit:
          default: null
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          - null
          type:
          - string
          - 'null'
      required:
      - otelName
      type: object
      x-versionadded: v2.41
    OtelMetricConfigSetPayload:
      properties:
        values:
          description: The list of OTel metric configurations.
          items:
            $ref: '#/components/schemas/OtelMetricConfigPayload'
          maxItems: 50
          type: array
      required:
      - values
      type: object
      x-versionadded: v2.41
    OtelMetricConfigUpdatePayload:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          enum:
          - sum
          - average
          - min
          - max
          - cardinality
          - percentiles
          - histogram
          type: string
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type: string
        enabled:
          description: Whether the OTel metric is enabled.
          type: boolean
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        percentile:
          description: The metric percentile for the percentile aggregation of histograms.
          exclusiveMinimum: 0.0
          maximum: 1.0
          type:
          - number
          - 'null'
        unit:
          default: null
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          - null
          type:
          - string
          - 'null'
      type: object
      x-versionadded: v2.41
    OtelMetricHistogramBucketValue:
      properties:
        count:
          description: The count of the bucket values.
          type: integer
        value:
          description: The value of the bucket.
          type: number
      required:
      - count
      - value
      type: object
      x-versionadded: v2.41
    OtelMetricResolution:
      enum:
      - PT1M
      - PT5M
      - PT1H
      - P1D
      - P7D
      - P1M
      title: OtelMetricResolution
      type: string
    OtelMetricSegment:
      description: The segment definition.
      properties:
        attribute:
          description: The segment attribute name.
          maxLength: 255
          type: string
        values:
          description: The segment values.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
      required:
      - attribute
      - values
      type: object
      x-versionadded: v2.4
    OtelMetricSegmentPeriod:
      properties:
        endTime:
          description: The end time of the metric value period.
          format: date-time
          type: string
        startTime:
          description: The start time of the metric value period.
          format: date-time
          type: string
        values:
          description: The list of OTel metric segment values for the period.
          items:
            $ref: '#/components/schemas/OtelMetricSegmentValue'
          maxItems: 1000
          type: array
      required:
      - endTime
      - startTime
      - values
      type: object
      x-versionadded: v2.4
    OtelMetricSegmentValue:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          type:
          - string
          - 'null'
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        segmentValues:
          description: The values for each segment.
          items:
            type: number
          maxItems: 10
          minItems: 1
          type: array
      required:
      - otelName
      - segmentValues
      type: object
      x-versionadded: v2.4
    OtelMetricSegmentedValueResponse:
      properties:
        data:
          description: The list of segmented metric value periods.
          items:
            $ref: '#/components/schemas/OtelMetricSegmentPeriod'
          maxItems: 200
          type: array
        interval:
          description: The interval for the metric values.
          enum:
          - PT1M
          - PT5M
          - PT1H
          - P1D
          - P7D
          type: string
        segment:
          $ref: '#/components/schemas/OtelMetricSegment'
      required:
      - data
      - interval
      - segment
      type: object
      x-versionadded: v2.4
    OtelMetricSummary:
      properties:
        description:
          description: The description of the reported metric.
          type:
          - string
          - 'null'
        metricType:
          description: The reported metric type (e.g., counter, gauge, histogram).
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          type: string
        units:
          description: The units of the reported metric.
          type:
          - string
          - 'null'
      required:
      - otelName
      type: object
      x-versionadded: v2.41
    OtelMetricSummaryResponse:
      properties:
        data:
          description: The list of information about available OTel metrics.
          items:
            $ref: '#/components/schemas/OtelMetricSummary'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.41
    OtelMetricTimeBucketValue:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          type:
          - string
          - 'null'
        buckets:
          description: The histogram bucket values.
          items:
            $ref: '#/components/schemas/OtelMetricHistogramBucketValue'
          maxItems: 100
          type: array
        delta:
          description: The difference from the previous period (if any).
          type:
          - number
          - 'null'
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        id:
          description: The metric configuration ID (if any).
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        samples:
          description: The number of OTel metric values for the period.
          type: integer
        unit:
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          type:
          - string
          - 'null'
        value:
          description: The metric value for the period.
          type:
          - number
          - 'null'
      required:
      - otelName
      - samples
      type: object
      x-versionadded: v2.41
    OtelMetricValuePeriod:
      properties:
        endTime:
          description: The end time of the metric value period.
          format: date-time
          type: string
        startTime:
          description: The start time of the metric value period.
          format: date-time
          type: string
        values:
          description: The list of OTel metric values for the period.
          items:
            $ref: '#/components/schemas/OtelMetricTimeBucketValue'
          maxItems: 50
          type: array
      required:
      - endTime
      - startTime
      - values
      type: object
      x-versionadded: v2.41
    OtelMetricValuesOverTimeResponse:
      properties:
        data:
          description: The list of OTel metric value periods.
          items:
            $ref: '#/components/schemas/OtelMetricValuePeriod'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.41
    OtelMetricValuesOverTimeSegmentByMultipleAttrsRequest:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          enum:
          - sum
          - average
          - min
          - max
          - cardinality
          - percentiles
          - histogram
          type: string
        endTime:
          description: The end time to filter data by.
          format: date-time
          type: string
        interval:
          default: PT1H
          description: The interval for the metric values.
          enum:
          - PT1M
          - PT5M
          - PT1H
          - P1D
          - P7D
          type: string
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        searchKeys:
          description: The list of search keys.
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
          x-versionadded: v2.46
        searchValues:
          description: The list of search values.
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
          x-versionadded: v2.46
        segments:
          description: The list of attributes to segment results by.
          items:
            $ref: '#/components/schemas/OtelMetricAttributeList'
          maxItems: 50
          type: array
        startTime:
          description: The start time to filter data by.
          format: date-time
          type: string
      required:
      - aggregation
      - otelName
      - segments
      type: object
      x-versionadded: v2.39
    OtelMetricValuesOverTimeSegmentByMultipleAttrsResponse:
      properties:
        data:
          description: The list of metric values over time segmented by the requested
            attributes.
          items:
            $ref: '#/components/schemas/OtelMetricAttributeWithValuesList'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.39
    OtelPodInfo:
      properties:
        containers:
          description: The list of containers in the pod.
          items:
            $ref: '#/components/schemas/OtelContainerInfo'
          maxItems: 1000
          type: array
        name:
          description: The name of the pod.
          type: string
      required:
      - containers
      - name
      type: object
      x-versionadded: v2.46
    OtelPodsInfoResponse:
      properties:
        data:
          description: The list of pods and containers available in the service's
            OTel storage.
          items:
            $ref: '#/components/schemas/OtelPodInfo'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.46
    OtelSingleMetricTimeBucketValue:
      properties:
        buckets:
          description: The histogram bucket values.
          items:
            $ref: '#/components/schemas/OtelMetricHistogramBucketValue'
          maxItems: 100
          type: array
        delta:
          description: The difference from the previous period (if any).
          type:
          - number
          - 'null'
        endTime:
          description: The end time of the metric value period.
          format: date-time
          type: string
        samples:
          description: The number of OTel metric values for the period.
          type: integer
        startTime:
          description: The start time of the metric value period.
          format: date-time
          type: string
        value:
          description: The metric value for the period.
          type:
          - number
          - 'null'
      required:
      - endTime
      - samples
      - startTime
      type: object
      x-versionadded: v2.41
    OtelSingleMetricValueOverTimeResponse:
      properties:
        aggregation:
          description: The aggregation method used for metric display.
          type:
          - string
          - 'null'
        displayName:
          description: The display name of the metric.
          maxLength: 127
          type:
          - string
          - 'null'
        id:
          description: The metric configuration ID (if any).
          type:
          - string
          - 'null'
        otelName:
          description: The OTel key of the metric.
          maxLength: 255
          type: string
        timeBuckets:
          description: The list of OTel metric value periods.
          items:
            $ref: '#/components/schemas/OtelSingleMetricTimeBucketValue'
          maxItems: 1000
          type: array
        unit:
          description: The unit of measurement for the metric.
          enum:
          - bytes
          - nanocores
          - percentage
          type:
          - string
          - 'null'
      required:
      - otelName
      - timeBuckets
      type: object
      x-versionadded: v2.41
    OtelStats:
      properties:
        logCount:
          description: The number of logs used by this entity.
          type: integer
        metricCount:
          description: The number of metrics used by this entity.
          type: integer
        serviceName:
          description: Service name of the process.
          type: string
        spanCount:
          description: The number of spans used by this entity.
          type: integer
        userId:
          description: The user ID.
          type: string
      required:
      - logCount
      - metricCount
      - serviceName
      - spanCount
      - userId
      type: object
      x-versionadded: v2.43
    OtelStatsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: OTel entity statistics.
          items:
            $ref: '#/components/schemas/OtelStats'
          maxItems: 10000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.43
    OutputStorageType:
      description: The possible allowed values for where/how notebook cell output
        is stored.
      enum:
      - RAW_OUTPUT
      title: OutputStorageType
      type: string
    OutputType:
      description: 'Type of cell output. This is a superset of the permitted values
        for "output_type" in the nbformat v4 schema.


        References:

        - https://nbformat.readthedocs.io/en/latest/format_description.html#code-cell-outputs

        - https://github.com/jupyter/nbformat/blob/5.3.0/nbformat/v4/nbformat.v4.schema.json#L301-L406

        - services.runner.kernel.KernelMessageType'
      enum:
      - execute_result
      - stream
      - display_data
      - error
      - pyout
      - pyerr
      - input_request
      title: OutputType
      type: string
    OverallConfigUpdate:
      description: Overall moderation configuration to push (not specific to one guard)
      properties:
        nemoEvaluatorDeploymentId:
          description: ID of NeMo Evaluator deployment to use for all NeMo Evaluator
            guards.
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        timeoutAction:
          description: Action to take if timeout occurs
          enum:
          - block
          - score
          type: string
        timeoutSec:
          description: Timeout value in seconds for any guard
          minimum: 2
          type: integer
      required:
      - timeoutAction
      - timeoutSec
      type: object
      x-versionadded: v2.35
    OverallModerationConfigurationResponse:
      properties:
        entityId:
          description: The ID of the custom model or playground for this configuration.
          type: string
        entityType:
          description: The type of the associated entity.
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
        nemoEvaluatorDeploymentId:
          description: The ID of the NeMo Evaluator deployment to use for all NeMo
            Evaluator guards.
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        timeoutAction:
          description: The action to take if timeout occurs.
          enum:
          - block
          - score
          type: string
        timeoutSec:
          description: The timeout value in seconds for any guard.
          minimum: 2
          type: integer
        updatedAt:
          description: When the configuration was updated.
          format: date-time
          type: string
        updaterId:
          description: The ID of the user who updated the configuration.
          type:
          - string
          - 'null'
      required:
      - entityId
      - entityType
      - timeoutAction
      - timeoutSec
      - updaterId
      type: object
      x-versionadded: v2.35
    OverallModerationConfigurationUpdate:
      properties:
        entityId:
          description: The ID of the custom model or playground for this configuration.
          type: string
        entityType:
          description: The type of the associated entity.
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
        nemoEvaluatorDeploymentId:
          description: The ID of the NeMo Evaluator deployment to use for all NeMo
            Evaluator guards.
          type:
          - string
          - 'null'
          x-versionadded: v2.42
        timeoutAction:
          description: The action to take if timeout occurs.
          enum:
          - block
          - score
          type: string
        timeoutSec:
          description: The timeout value in seconds for any guard.
          minimum: 0
          type: integer
      required:
      - entityId
      - entityType
      - timeoutAction
      - timeoutSec
      type: object
      x-versionadded: v2.35
    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.
          type:
          - string
          - 'null'
        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
    PaginatedDataframeQuery:
      description: Query schema for paginated dataframe requests.
      properties:
        cellId:
          description: ID of the cell.
          title: Cellid
          type: string
        limit:
          default: 10
          description: Maximum number of objects to return.
          exclusiveMinimum: 0.0
          maximum: 1000.0
          title: Limit
          type: integer
        offset:
          default: 0
          description: Offset for pagination.
          minimum: 0.0
          title: Offset
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
        sortBy:
          description: Sort results by this field.
          title: Sortby
          type: string
      required:
      - path
      - cellId
      title: PaginatedDataframeQuery
      type: object
    PaginatedResponse_EventResponse_:
      properties:
        items:
          description: List of items for the current page
          items:
            $ref: '#/components/schemas/EventResponse'
          maxItems: 100
          title: Items
          type: array
        limit:
          description: Maximum number of returned items
          exclusiveMinimum: 0.0
          title: Limit
          type: integer
        offset:
          description: Number of skipped items
          minimum: 0.0
          title: Offset
          type: integer
        total:
          description: Total number of matching items
          title: Total
          type: integer
      required:
      - items
      - offset
      - limit
      - total
      title: PaginatedResponse[EventResponse]
      type: object
    PaginatedResponse_MemorySpaceResponse_:
      properties:
        items:
          description: List of items for the current page
          items:
            $ref: '#/components/schemas/MemorySpaceResponse'
          maxItems: 100
          title: Items
          type: array
        limit:
          description: Maximum number of returned items
          exclusiveMinimum: 0.0
          title: Limit
          type: integer
        offset:
          description: Number of skipped items
          minimum: 0.0
          title: Offset
          type: integer
        total:
          description: Total number of matching items
          title: Total
          type: integer
      required:
      - items
      - offset
      - limit
      - total
      title: PaginatedResponse[MemorySpaceResponse]
      type: object
    PaginatedResponse_SessionResponse_:
      properties:
        items:
          description: List of items for the current page
          items:
            $ref: '#/components/schemas/SessionResponse'
          maxItems: 100
          title: Items
          type: array
        limit:
          description: Maximum number of returned items
          exclusiveMinimum: 0.0
          title: Limit
          type: integer
        offset:
          description: Number of skipped items
          minimum: 0.0
          title: Offset
          type: integer
        total:
          description: Total number of matching items
          title: Total
          type: integer
      required:
      - items
      - offset
      - limit
      - total
      title: PaginatedResponse[SessionResponse]
      type: object
    PairwiseManualSelectionCreatePayload:
      properties:
        columnLabels:
          description: Manually selected column labels.
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        featureName:
          description: The name of the feature the request is related to.
          type:
          - string
          - 'null'
        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: The ID of the project the request is related to.
          type:
          - string
          - 'null'
        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: The 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: The 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: The 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: The list of manually selected label sets.
          items:
            $ref: '#/components/schemas/PairwiseManualSelectionCreatedItem'
          type: array
        featureName:
          description: The name of the feature the request is related to.
          type:
          - string
          - 'null'
        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: The ID of the project the request is related to.
          type:
          - string
          - 'null'
      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.
          type:
          - number
          - 'null'
      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: The 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
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            type: array
      required:
      - param
      - value
      type: object
    ParameterItem:
      properties:
        parameterName:
          description: The name of the parameter.
          type: string
        parameterValue:
          description: The value of the parameter.
          type: number
      required:
      - parameterName
      - parameterValue
      type: object
      x-versionadded: v2.39
    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.
          oneOf:
          - $ref: '#/components/schemas/HyperparametersResponse'
          - type: 'null'
        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
    PartFinalizeResponse:
      properties:
        checksum:
          description: The checksum of the part.
          type: string
        number:
          description: The number of the part.
          type: integer
        size:
          description: The size of the part.
          type: integer
      required:
      - checksum
      - number
      - size
      type: object
      x-versionadded: v2.35
    PartUploadRequest:
      properties:
        file:
          description: The part file to upload to the data stage.
          format: binary
          type: string
      required:
      - file
      type: object
      x-versionadded: v2.35
    PartUploadResponse:
      properties:
        checksum:
          description: The checksum of the part.
          type: string
        size:
          description: The size of the part.
          type: integer
      required:
      - checksum
      - size
      type: object
      x-versionadded: v2.35
    PartialDependence:
      description: Partial dependence results. Can be missing if no data for the feature
        was qualified to generate the insight.
      properties:
        data:
          description: The 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
            a string.
          type: string
      required:
      - dependence
      - label
      type: object
    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.
      properties:
        cvHoldoutLevel:
          description: If a user partition column was used with cross validation,
            the value assigned to the holdout set
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        datetimePartitionColumn:
          description: If a datetime partition column was used, the name of the column.
          type:
          - string
          - 'null'
        holdoutLevel:
          description: If a user partition column was used with train-validation-holdout
            split, the value assigned to the holdout set.
          type:
          - string
          - 'null'
        holdoutPct:
          description: The percentage of the dataset reserved for the holdout set.
          type:
          - number
          - 'null'
        partitionKeyCols:
          description: An array containing a single string - the name of the group
            partition column
          items:
            type: string
          type: array
        reps:
          description: If cross validation was used, the number of folds to use.
          type:
          - integer
          - 'null'
        trainingLevel:
          description: If a user partition column was used with train-validation-holdout
            split, the value assigned to the training set.
          type:
          - string
          - 'null'
        useTimeSeries:
          description: Indicates whether a time series project was created as opposed
            to a regular project using datetime partitioning.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.9
        userPartitionCol:
          description: If a user partition column was used, the name of the column.
          type:
          - string
          - 'null'
        validationLevel:
          description: If a user partition column was used with train-validation-holdout
            split, the value assigned to the validation set.
          type:
          - string
          - 'null'
        validationPct:
          description: If train-validation-holdout split was used, the percentage
            of the dataset used for the validation set.
          type:
          - number
          - 'null'
        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.
          type:
          - integer
          - 'null'
        partition:
          description: The 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: The warning message.
          type: string
        title:
          description: The warning short title.
          type: string
        type:
          description: The 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.
          type:
          - integer
          - 'null'
        partition:
          description: The 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
    PasswordOAuthFlow:
      description: Configuration for the OAuth 2.0 Resource Owner Password flow.
      properties:
        refreshUrl:
          description: The URL for refreshing tokens.
          type:
          - string
          - 'null'
        scopes:
          additionalProperties:
            type: string
          description: Available scopes mapping scope name to description.
          type: object
        tokenUrl:
          description: The token URL for the password flow.
          type: string
      required:
      - scopes
      - tokenUrl
      type: object
      x-versionadded: v2.46
    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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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
        recipeType:
          description: The recipe workflow type.
          enum:
          - sql
          - Sql
          - SQL
          - wrangling
          - Wrangling
          - WRANGLING
          - featureDiscovery
          - FeatureDiscovery
          - FEATURE_DISCOVERY
          - featureDiscoveryPrivatePreview
          - FeatureDiscoveryPrivatePreview
          - FEATURE_DISCOVERY_PRIVATE_PREVIEW
          type: string
          x-versionadded: v2.36
        sql:
          description: Recipe SQL query.
          maxLength: 320000
          type: string
          x-versionadded: v2.36
      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: The 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: The number of items on the current page.
          type: integer
        data:
          description: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page)
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The 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: The ID of the payoff matrix.
          type: string
        name:
          description: The label for the payoff matrix.
          type: string
        projectId:
          description: The 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
          type:
          - number
          - 'null'
        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
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
      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
          type:
          - number
          - 'null'
        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: The 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 affected
            the prediction (e.g., '+++', '--', '+', '<+', '<-').
          type: string
          x-versionadded: v2.28
        strength:
          description: The amount these ngrams 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:
      description: Statistics for all data for different feature values.
      properties:
        allOther:
          description: A percentage of rows that do not have any of these values or
            categories.
          maximum: 100
          minimum: 0
          type:
          - number
          - 'null'
        missingRowsPercent:
          description: A percentage of all rows that have a missing value for this
            feature.
          maximum: 100
          minimum: 0
          type:
          - number
          - 'null'
        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:
        geoCentroid:
          $ref: '#/components/schemas/GeoPoint'
          x-versionadded: v2.36
        percent:
          description: Percent of the percentile
          type: number
        value:
          description: Predicted value or probability at a percentile
          type:
          - number
          - 'null'
      required:
      - percent
      type: object
    Period:
      additionalProperties: false
      description: Time period definition.
      properties:
        end:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Period end time
          title: End
        start:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Period start time
          title: Start
      title: Period
      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
    PermissionSet:
      description: Permission set for project entities.
      properties:
        admin:
          description: Whether admin access is granted.
          type: boolean
        read:
          description: Whether read access is granted.
          type: boolean
        write:
          description: Whether write access is granted.
          type: boolean
      type: object
      x-versionadded: v2.36
    PermissionSetInfo:
      properties:
        active:
          description: Whether the entity is usable in the system.
          type: boolean
        admin:
          description: Whether admin access is granted.
          type: boolean
        entity:
          description: The internal name of the entity.
          enum:
          - APPLICATION
          - ARTIFACT
          - ARTIFACT_REPOSITORY
          - AUDIT_LOG
          - COMPUTE_CLUSTERS_MANAGEMENT
          - CUSTOM_APPLICATION
          - CUSTOM_APPLICATION_SOURCE
          - CUSTOM_ENVIRONMENT
          - CUSTOM_MODEL
          - DATASET_DATA
          - DATASET_INFO
          - DATA_SOURCE
          - DATA_STORE
          - DEPLOYMENT
          - DYNAMIC_SYSTEM_CONFIG
          - ENTITLEMENT_DEFINITION
          - ENTITLEMENT_SET
          - ENTITLEMENT_SET_LEASE
          - EXPERIMENT_CONTAINER
          - EXTERNAL_APPLICATION
          - GROUP
          - MODEL_PACKAGE
          - NOTIFICATION_POLICY
          - ORGANIZATION
          - PREDICTION_ENVIRONMENT
          - PREDICTION_SERVER
          - PROJECT
          - REGISTERED_MODEL
          - RISK_MANAGEMENT_FRAMEWORK
          - USER
          - WORKLOAD
          type: string
        entityName:
          description: The readable name of the entity.
          type: string
        read:
          description: Whether read access is granted.
          type: boolean
        write:
          description: Whether write access is granted.
          type: boolean
      required:
      - active
      - entity
      - entityName
      type: object
      x-versionadded: v2.36
    Permissions:
      description: The permissions for the new Access Role. Each entity type accepts
        a specific subset of the valid permissions.
      properties:
        APPLICATION:
          $ref: '#/components/schemas/PermissionSet'
        ARTIFACT:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.43
        ARTIFACT_REPOSITORY:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.43
        AUDIT_LOG:
          $ref: '#/components/schemas/PermissionSet'
        COMPUTE_CLUSTERS_MANAGEMENT:
          $ref: '#/components/schemas/PermissionSet'
        CUSTOM_APPLICATION:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.39
        CUSTOM_APPLICATION_SOURCE:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.39
        CUSTOM_ENVIRONMENT:
          $ref: '#/components/schemas/PermissionSet'
        CUSTOM_MODEL:
          $ref: '#/components/schemas/PermissionSet'
        DATASET_DATA:
          $ref: '#/components/schemas/PermissionSet'
        DATASET_INFO:
          $ref: '#/components/schemas/PermissionSet'
        DATA_SOURCE:
          $ref: '#/components/schemas/PermissionSet'
        DATA_STORE:
          $ref: '#/components/schemas/PermissionSet'
        DEPLOYMENT:
          $ref: '#/components/schemas/PermissionSet'
        DYNAMIC_SYSTEM_CONFIG:
          $ref: '#/components/schemas/PermissionSet'
        ENTITLEMENT_DEFINITION:
          $ref: '#/components/schemas/PermissionSet'
        ENTITLEMENT_SET:
          $ref: '#/components/schemas/PermissionSet'
        ENTITLEMENT_SET_LEASE:
          $ref: '#/components/schemas/PermissionSet'
        EXPERIMENT_CONTAINER:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.38
        EXTERNAL_APPLICATION:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.45
        GROUP:
          $ref: '#/components/schemas/PermissionSet'
        MODEL_PACKAGE:
          $ref: '#/components/schemas/PermissionSet'
        NOTIFICATION_POLICY:
          $ref: '#/components/schemas/PermissionSet'
        ORGANIZATION:
          $ref: '#/components/schemas/PermissionSet'
        PREDICTION_ENVIRONMENT:
          $ref: '#/components/schemas/PermissionSet'
        PREDICTION_SERVER:
          $ref: '#/components/schemas/PermissionSet'
        PROJECT:
          $ref: '#/components/schemas/PermissionSet'
        REGISTERED_MODEL:
          $ref: '#/components/schemas/PermissionSet'
        RISK_MANAGEMENT_FRAMEWORK:
          $ref: '#/components/schemas/PermissionSet'
        USER:
          $ref: '#/components/schemas/PermissionSet'
        WORKLOAD:
          $ref: '#/components/schemas/PermissionSet'
          x-versionadded: v2.43
      type: object
      x-versionadded: v2.36
    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.
          oneOf:
          - maximum: 19
            minimum: 0
            type: integer
          - enum:
            - holdout
            type: string
          - type: 'null'
          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: The URL for the next page of results, or null if there is no
            next page.
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL for the previous page of results, or null if there
            is no previous page.
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - integer
          - 'null'
          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
    PineconeCloud:
      description: Supported cloud providers for Pinecone.
      enum:
      - aws
      - gcp
      - azure
      title: PineconeCloud
      type: string
    PineconeConnection:
      description: Pinecone vector database connection.
      properties:
        cloud:
          $ref: '#/components/schemas/PineconeCloud'
          description: The cloud provider to create the index.
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        region:
          description: The region to create the index.
          maxLength: 5000
          minLength: 1
          title: region
          type: string
        type:
          const: pinecone
          default: pinecone
          description: The type of the external vector database.
          title: type
          type: string
      required:
      - credentialId
      - cloud
      - region
      title: PineconeConnection
      type: object
    PineconeConnectionRequest:
      description: Pinecone vector database connection.
      properties:
        cloud:
          $ref: '#/components/schemas/PineconeCloud'
          description: The cloud provider to create the index.
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        region:
          description: The region to create the index.
          maxLength: 5000
          minLength: 1
          title: region
          type: string
        type:
          const: pinecone
          default: pinecone
          description: The type of the external vector database.
          title: type
          type: string
      required:
      - credentialId
      - cloud
      - region
      title: PineconeConnectionRequest
      type: object
    PinnedUsecaseResponse:
      properties:
        advancedTour:
          description: Advanced tour key.
          type:
          - string
          - 'null'
        applicationsCount:
          description: The number of applications in a use case.
          type: integer
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        createdAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        customApplicationsCount:
          description: The number of custom applications referenced in a use case.
          type: integer
        customJobsCount:
          description: The number of custom jobs referenced in a use case.
          type: integer
        customModelVersionsCount:
          description: The number of custom models referenced in a use case.
          type: integer
        datasetsCount:
          description: The number of datasets in a use case.
          type: integer
        deploymentsCount:
          description: The number of deployments referenced in a use case.
          type: integer
        description:
          description: The description of the Use Case.
          type:
          - string
          - 'null'
        filesCount:
          description: The number of files in a use case.
          type: integer
          x-versionadded: v2.37
        formattedDescription:
          description: The formatted description of the experiment container used
            as styled description.
          type:
          - string
          - 'null'
        id:
          description: The ID of the Use Case.
          type: string
        modelsCount:
          description: '[DEPRECATED] The number of models in a Use Case.'
          type: integer
          x-versiondeprecated: v2.34
        name:
          description: The name of the Use Case.
          type: string
        notebooksCount:
          description: The number of notebooks in a use case.
          type: integer
        projectsCount:
          description: The number of projects in a use case.
          type: integer
        recipesCount:
          description: The number of recipes in a Use Case.
          type: integer
        registeredModelVersionsCount:
          description: The number of registered models referenced in a use case.
          type: integer
        riskAssessments:
          description: The ID List of the Risk Assessments.
          items:
            type: string
          maxItems: 100
          type: array
        role:
          description: The requesting user's role on this Use Case.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          type: string
          x-versionadded: v2.37
        tenantId:
          description: The ID of the tenant to associate this organization with.
          type:
          - string
          - 'null'
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        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.
          type:
          - string
          - 'null'
        valueTrackerId:
          description: The ID of the Value Tracker.
          type:
          - string
          - 'null'
      required:
      - applicationsCount
      - created
      - createdAt
      - customApplicationsCount
      - customJobsCount
      - customModelVersionsCount
      - datasetsCount
      - deploymentsCount
      - description
      - filesCount
      - id
      - name
      - notebooksCount
      - projectsCount
      - recipesCount
      - registeredModelVersionsCount
      - role
      - tenantId
      - updated
      - updatedAt
      type: object
      x-versionadded: v2.36
    PinnedUsecaseUpdatePayload:
      properties:
        operation:
          description: Pinned Use Case possible operations.
          enum:
          - add
          - remove
          type: string
        pinnedUseCasesIds:
          description: The list of the pinned Use Case IDs.
          items:
            type: string
          maxItems: 8
          minItems: 1
          type: array
      required:
      - operation
      - pinnedUseCasesIds
      type: object
      x-versionadded: v2.36
    PinnedUsecasesResponse:
      properties:
        data:
          description: The list of the pinned use cases.
          items:
            $ref: '#/components/schemas/PinnedUsecaseResponse'
          maxItems: 8
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.36
    PipelineStage:
      description: Enum that describes at which stage the metric may be calculated.
      enum:
      - prompt_pipeline
      - response_pipeline
      title: PipelineStage
      type: string
    PlaygroundResponse:
      description: API response object for a single playground.
      properties:
        creationDate:
          description: The creation date of the playground (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: The ID of the user that created this playground.
          title: creationUserId
          type: string
        description:
          description: The description of the playground.
          title: description
          type: string
        id:
          description: The ID of the playground.
          title: id
          type: string
        lastUpdateDate:
          description: The date of the most recent update of this playground (ISO
            8601 formatted).
          format: date-time
          title: lastUpdateDate
          type: string
        lastUpdateUserId:
          description: The ID of the user that made the most recent update to this
            playground.
          title: lastUpdateUserId
          type: string
        llmBlueprintsCount:
          description: The number of LLM blueprints in this playground.
          title: llmBlueprintsCount
          type: integer
        name:
          description: The name of the playground.
          title: name
          type: string
        playgroundType:
          $ref: '#/components/schemas/PlaygroundType'
          default: rag
          description: The type of the playground.
        savedLLMBlueprintsCount:
          description: The number of saved LLM blueprints in this playground.
          title: savedLLMBlueprintsCount
          type: integer
        useCaseId:
          description: The ID of the use case this playground belongs to.
          title: useCaseId
          type: string
        userName:
          description: The name of the user that created this playground.
          title: userName
          type: string
      required:
      - id
      - name
      - description
      - useCaseId
      - creationDate
      - creationUserId
      - lastUpdateDate
      - lastUpdateUserId
      - savedLLMBlueprintsCount
      - llmBlueprintsCount
      - userName
      title: PlaygroundResponse
      type: object
    PlaygroundType:
      description: Playground type.
      enum:
      - rag
      - agentic
      title: PlaygroundType
      type: string
    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
          type:
          - string
          - 'null'
      required:
      - id
      type: object
    Ports:
      properties:
        description:
          description: The optional description of the port.
          maxLength: 500
          type:
          - string
          - 'null'
        port:
          description: The port number to expose.
          maximum: 65535
          minimum: 1024
          type: integer
      required:
      - port
      type: object
      x-versionadded: v2.38
    PostgresConnection:
      description: Postgres vector database connection.
      properties:
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        database:
          description: The name of the database.
          maxLength: 5000
          minLength: 1
          title: database
          type: string
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        host:
          description: The host for the Postgres connection.
          maxLength: 5000
          minLength: 1
          title: host
          type: string
        port:
          default: 5432
          description: The port for the Postgres connection.
          maximum: 65535.0
          minimum: 0.0
          title: port
          type: integer
        schema:
          default: public
          description: The name of the schema.
          maxLength: 5000
          minLength: 1
          title: schema
          type: string
        sslmode:
          $ref: '#/components/schemas/PostgresSSLMode'
          default: require
          description: The SSL mode for the Postgres connection.
        type:
          const: postgres
          default: postgres
          description: The type of the external vector database.
          title: type
          type: string
      required:
      - credentialId
      - host
      - database
      title: PostgresConnection
      type: object
    PostgresConnectionRequest:
      description: Postgres vector database connection.
      properties:
        credentialId:
          description: The ID of the credential used to connect to the external vector
            database.
          title: credentialId
          type: string
        credentialUserId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the user supplying the credential used to connect
            to the external vector database.
          title: credentialUserId
        database:
          description: The name of the database.
          maxLength: 5000
          minLength: 1
          title: database
          type: string
        distanceMetric:
          $ref: '#/components/schemas/DistanceMetric'
          default: cosine
          description: The distance strategy to use for building the vector database.
        host:
          description: The host for the Postgres connection.
          maxLength: 5000
          minLength: 1
          title: host
          type: string
        port:
          default: 5432
          description: The port for the Postgres connection.
          maximum: 65535.0
          minimum: 0.0
          title: port
          type: integer
        schema:
          default: public
          description: The name of the schema.
          maxLength: 5000
          minLength: 1
          title: schema
          type: string
        sslmode:
          $ref: '#/components/schemas/PostgresSSLMode'
          default: require
          description: The SSL mode for the Postgres connection.
        type:
          const: postgres
          default: postgres
          description: The type of the external vector database.
          title: type
          type: string
      required:
      - credentialId
      - host
      - database
      title: PostgresConnectionRequest
      type: object
    PostgresSSLMode:
      description: SSL modes for Postgres vector databases.
      enum:
      - prefer
      - require
      - verify-full
      title: PostgresSSLMode
      type: string
    PredictJobDetailsResponse:
      properties:
        id:
          description: The job ID.
          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 times this was the actual class but `classMetrics.className`
            was predicted
          type: number
      required:
      - otherClassName
      - percentage
      type: object
    PredictedVsActual:
      description: Predicted versus actual results. Can be missing if no data for
        the feature was qualified to generate the insight.
      properties:
        data:
          description: The 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: The predicted versus actual results on a log scale.
          items:
            $ref: '#/components/schemas/PredictedVsActualData'
          type: array
      required:
      - data
      - isCapped
      - logScaledData
      type: object
    PredictedVsActualData:
      properties:
        actual:
          description: The actual value. `null` for 0-row bins and unsupervised time
            series models.
          type:
          - number
          - 'null'
        bin:
          description: The labels for the left and right bin limits for numeric features.
          items:
            type: string
          type: array
        label:
          description: Contains label for categorical features; For numeric features
            contains range or numeric value.
          type: string
        predicted:
          description: The predicted value. `null` for 0-row bins.
          type:
          - number
          - 'null'
        rowCount:
          description: The number of rows for the label and bin.
          type: integer
      required:
      - actual
      - label
      - predicted
      - rowCount
      type: object
    PredictionArrayObjectValues:
      description: Predicted values.
      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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          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:
      description: A prediction data time range definition.
      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).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
      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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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.
          type:
          - boolean
          - 'null'
          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'
          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, the 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.
          type:
          - string
          - 'null'
          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: The 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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        projectId:
          description: The project ID that owns this dataset.
          type: string
        secondaryDatasetsConfigId:
          description: Only available for feature discovery projects. The 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:
      description: The prediction environment that will be associated with the challengers
        created by retraining policies.
      properties:
        id:
          description: ID of the prediction environment.
          type: string
        name:
          description: Name of the prediction environment.
          type: string
      required:
      - id
      - name
      type: object
    PredictionEnvironmentInUseResponse:
      properties:
        id:
          description: ID of prediction environment.
          type: string
        name:
          description: Name of prediction environment.
          type: string
        usedBy:
          description: Guards using this prediction environment.
          items:
            $ref: '#/components/schemas/DeploymentAndGuardResponse'
          maxItems: 32
          type: array
      required:
      - id
      - name
      - usedBy
      type: object
      x-versionadded: v2.35
    PredictionEnvironmentResponse:
      description: Prediction environment used by the challenger
      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.
          type:
          - string
          - 'null'
          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. A large positive effect is denoted '+++', medium '++',
            small '+', very small '<+'. A large negative effect is denoted '---',
            medium '--', small '-', very small '<-'.
          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: Sets a list of selected class names for which corresponding
            explanations are returned in each row. This setting is mutually exclusive
            with numTopClasses. If neither parameter is specified, the default setting
            is numTopClasses=1.
          items:
            type: string
          maxItems: 100
          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: Sets the number of most probable (top predicted) classes for
            which corresponding explanations are returned in each row. This setting
            is mutually exclusive with classNames. If neither parameter is specified,
            the default setting is numTopClasses=1.
          maximum: 100
          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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
      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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
      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:
      description: Prediction explanation metadata.
      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:
      description: Prediction explanation result.
      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.
          type:
          - number
          - 'null'
      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: The 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.
          type:
          - number
          - 'null'
        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.
          type:
          - number
          - 'null'
        thresholdLow:
          description: The prediction explanation low threshold. Predictions must
            be below this value (or above the thresholdHigh value) to have PredictionExplanations
            computed.
          type:
          - number
          - 'null'
      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).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
      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: The number of rows of prediction explanations 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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      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: The list of prediction explanations.
          items:
            $ref: '#/components/schemas/PredictionExplanation'
          type: array
        predictionThreshold:
          description: The threshold value used for classification prediction.
          type:
          - number
          - 'null'
        predictionValues:
          description: The list of prediction values.
          items:
            $ref: '#/components/schemas/PredictionExplanationsPredictionValues'
          type: array
        rowId:
          description: The 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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        timestamp:
          description: The 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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: URL to the previous page, or null if there is no such page
          type:
          - string
          - 'null'
          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: 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
        credentials:
          description: The 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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentialsFields'
          - $ref: '#/components/schemas/GcpCredentialsFields'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentialsFields'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentialsFields'
          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:
      description: The prediction intervals setting for the deployment.
      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: 0
            maximum: 100
            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: The number of items returned on this page.
          type: integer
        data:
          description: A descending-ordered array of already-calculated prediction
            intervals percentiles.
          items:
            exclusiveMinimum: 0
            maximum: 100
            type: integer
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      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.
          type:
          - string
          - 'null'
          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.
          type:
          - integer
          - 'null'
        forecastPoint:
          description: (if time series project) The forecastPoint of the predictions.
            Either provided or inferred.
          format: date-time
          type:
          - string
          - 'null'
        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
          type:
          - number
          - 'null'
        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'
          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'
          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: The list of predicted values for this row.
          items:
            $ref: '#/components/schemas/PredictionArrayObjectValues'
          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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        timestamp:
          description: (if time series project) The timestamp of this row in the prediction
            dataset.
          format: date-time
          type:
          - string
          - 'null'
      required:
      - prediction
      - rowId
      type: object
    PredictionRemoteEventData:
      description: Prediction event payload.
      properties:
        error_code:
          description: The error code if any.
          type:
          - string
          - 'null'
        model_id:
          description: The identifier of the model.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
      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.
          type:
          - integer
          - 'null'
          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
          type: array
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      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.
          type:
          - string
          - 'null'
          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).
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        featureDerivationWindowCounts:
          description: For time series projects with partial history only. Indicates
            how many points were used during feature derivation in the feature derivation
            window.
          type:
          - integer
          - 'null'
          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.
          type:
          - integer
          - 'null'
          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.
          oneOf:
          - type: string
          - type: integer
          - type: number
          - type: 'null'
        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.
          type:
          - integer
          - 'null'
          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.
          type:
          - number
          - 'null'
          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'
          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: The number of items returned on this page.
          type: integer
        data:
          description: The list of prediction servers.
          items:
            $ref: '#/components/schemas/PredictionServerResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    PredictionServerResponse:
      properties:
        batchPredictions:
          $ref: '#/components/schemas/BatchPredictionStatus'
          x-versionadded: v2.28
        datarobot-key:
          description: The `datarobot-key` header used in requests to this prediction
            server.
          type:
          - string
          - 'null'
        id:
          description: The ID of the prediction server.
          type:
          - string
          - 'null'
        url:
          description: The URL of the prediction server.
          type: string
      required:
      - batchPredictions
      - datarobot-key
      - id
      - url
      type: object
    PredictionSnippetModel:
      properties:
        cliScript:
          default: true
          description: When combined with is_standalone, a true value returns an example
            CLI run script for a snippet, while a false value returns an example executable
            script.
          type: boolean
          x-versionadded: v2.35
        deploymentId:
          description: The selected deployment ID.
          type: string
        isBatchPrediction:
          default: true
          description: If true, returns snippet that can be used to make batch predictions.
            Not valid with time series projects.
          type: boolean
        isLowLatencyPrediction:
          default: false
          description: If true, returns snippet that can be used to make low latency
            predictions.Valid for Feature Discovery projects.
          type: boolean
        isStandalone:
          default: false
          description: If true, returns an example script for a snippet.
          type: boolean
        showSecrets:
          default: false
          description: If true, the DATAROBOT_KEY AND DATROBOT_API_KEY will be available
            in the context.
          type: boolean
        testMode:
          default: false
          description: Generate a snippet with mocked information.
          type: boolean
        withApiClient:
          default: true
          description: Instead of raw Python code in the example, show a snippet using
            the DataRobot Python API client.
          type: boolean
      required:
      - deploymentId
      type: object
      x-versionadded: v2.35
    PredictionURLUpload:
      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. This value is optional.
          type: string
          x-versionadded: v2.21
        credentials:
          description: The 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.
          type:
          - string
          - 'null'
        datasetId:
          description: The ID of the dataset.
          type:
          - string
          - 'null'
        deploymentId:
          description: The ID of the deployment.
          type:
          - string
          - 'null'
        deploymentType:
          description: The type of the deployment.
          type:
          - string
          - 'null'
        groupId:
          description: The ID of the group.
          type:
          - string
          - 'null'
        groupName:
          description: The name of the group.
          type:
          - string
          - 'null'
        modelId:
          description: The ID of the model.
          type:
          - string
          - 'null'
        modelType:
          description: The type of the model.
          type:
          - string
          - 'null'
        orgId:
          description: The ID of the organization.
          type:
          - string
          - 'null'
        orgName:
          description: The name of the organization.
          type:
          - string
          - 'null'
        predictionExplanations:
          description: Whether it contains prediction explanations.
          type:
          - boolean
          - 'null'
        predictionMethod:
          description: The prediction method that was used.
          type: string
        predictionRowCountPerMinute:
          description: The list of row counts per minute.
          items:
            type: integer
          type: array
        predictionRowsCount:
          description: The count of prediction rows during the `timestamp` hour.
          type: integer
        projectId:
          description: The ID of the project.
          type:
          - string
          - 'null'
        projectType:
          description: The type of the project.
          type:
          - string
          - 'null'
        pythonVersion:
          description: The Python version used to build models in the project.
          type:
          - string
          - 'null'
        recommendedModel:
          description: Whether it is a recommended model.
          type:
          - boolean
          - 'null'
        requestCountPerMinute:
          description: The list of requests per minute.
          items:
            type: integer
          type: array
        requestsCount:
          description: The request count during the `timestamp` hour.
          type: integer
        serverErrorCount:
          description: The server error count during the `timestamp` hour.
          type: integer
        timestamp:
          description: The timestamp of the event.
          format: date-time
          type: string
        userErrorCount:
          description: The user error count during the `timestamp` hour.
          type: integer
        userId:
          description: The ID of the user.
          type: string
        userProjectRole:
          description: The role of the user to the related project.
          type:
          - string
          - 'null'
        username:
          description: The username of the user. Will be empty if ``includeIdentifyingFields``
            is True.
          type:
          - string
          - 'null'
      required:
      - avgExecutionTime
      - predictionExplanations
      - predictionMethod
      - predictionRowsCount
      - requestsCount
      - serverErrorCount
      - timestamp
      - userErrorCount
      - userId
      type: object
    PredictionUsageRetrieveResponse:
      properties:
        count:
          description: The number 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
          type:
          - string
          - 'null'
        previous:
          description: A URL to the previous page (if null, no previous page exists).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The number of items matching the query condition.
          type: integer
          x-versionadded: v2.23
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    PredictionWarning:
      description: The prediction warning setting for the deployment.
      properties:
        customBoundaries:
          $ref: '#/components/schemas/CustomBoundaries'
        enabled:
          description: Indicates whether prediction warnings are enabled for this
            deployment.
          type: boolean
      required:
      - enabled
      type: object
    PredictionsByForecastDate:
      description: Forecast date setting for the deployment.
      properties:
        columnName:
          description: The column name in prediction datasets to be used as forecast
            date
          type:
          - string
          - 'null'
        datetimeFormat:
          description: 'The datetime format of the forecast date column in prediction
            datasets.

            For time series deployments using the datetime format `%Y-%m-%d %H:%M:%S.%f`,

            DataRobot automatically populates a `v2` in front of the timestamp format.

            Date/time values submitted in prediction data should not include this
            `v2` prefix.

            Other timestamp formats are not affected.

            '
          type:
          - string
          - 'null'
        enabled:
          description: Indicates whether predictions by forecast dates is enabled
            for the deployment.
          type: boolean
      required:
      - enabled
      type: object
      x-versionadded: v2.35
    PredictionsDataCollection:
      description: The predictions data collection setting for the deployment.
      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'
          x-versionadded: v2.33
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          maxItems: 10000
          type: array
          x-versionadded: v2.33
        meanGeoCentroid:
          $ref: '#/components/schemas/GeoPoint'
          x-versionadded: v2.36
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          maxItems: 10000
          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'
          maxItems: 10
          type: array
          x-versionadded: v2.33
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        rowCount:
          description: Number of rows in the bucket.
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
      required:
      - baselines
      - buckets
      type: object
    PredictionsOverSpaceBucket:
      properties:
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          maxItems: 10000
          type: array
        hexagon:
          description: h3 hexagon.
          type:
          - string
          - 'null'
        meanGeoCentroid:
          $ref: '#/components/schemas/GeoPoint'
          x-versionadded: v2.36
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          maxItems: 10000
          type: array
        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'
          maxItems: 10
          type: array
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          type:
          - integer
          - 'null'
        rowCount:
          description: Number of rows in the bucket.
          type:
          - integer
          - 'null'
      required:
      - rowCount
      type: object
      x-versionadded: v2.35
    PredictionsOverSpaceResponse:
      properties:
        baselines:
          description: Baseline predictions per geospatial hexagon.
          items:
            $ref: '#/components/schemas/PredictionsOverSpaceBucket'
          maxItems: 10000
          type: array
        buckets:
          description: Predictions per geospatial hexagon.
          items:
            $ref: '#/components/schemas/PredictionsOverSpaceBucket'
          maxItems: 10000
          type: array
        geoFeatureName:
          description: The name of the geospatial feature. Segmented analysis must
            be enabled for the feature specified.
          type: string
        modelId:
          description: The ID of the model that predictions are being retrieved from.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
      required:
      - baselines
      - buckets
      - geoFeatureName
      type: object
      x-versionadded: v2.35
    PredictionsOverTimeBucket:
      properties:
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          maxItems: 10000
          type: array
        meanGeoCentroid:
          $ref: '#/components/schemas/GeoPoint'
          x-versionadded: v2.36
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          maxItems: 10000
          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'
          maxItems: 10
          type: array
        period:
          $ref: '#/components/schemas/TimeRange'
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          type:
          - integer
          - 'null'
        rowCount:
          description: Number of rows in the bucket.
          type:
          - integer
          - 'null'
      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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          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'
          type: array
        meanActualValue:
          description: Mean actual value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        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'
          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'
          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.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        modelId:
          description: ID of the model.
          type: string
          x-versionadded: v2.33
        period:
          $ref: '#/components/schemas/BatchPeriod'
          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'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
      required:
      - baselines
      - buckets
      type: object
    PredictionsVsActualsOverSpaceBucket:
      properties:
        actualClassDistribution:
          description: For classification deployments, the class distribution for
            all actuals in the bucket.
          items:
            $ref: '#/components/schemas/ActualClassDistribution'
          maxItems: 125
          type: array
        hexagon:
          description: The H3 geospatial indexing hexagon.
          type: string
        meanActualValue:
          description: For regression deployments, the mean actual value of all rows
            in the bucket.
          type:
          - number
          - 'null'
        meanPredictedValue:
          description: For regression deployments, the mean predicted value of all
            rows in the bucket.
          type:
          - number
          - 'null'
        predictedClassDistribution:
          description: For classification deployments, the class distribution for
            all prediction rows in the bucket with associated actuals.
          items:
            $ref: '#/components/schemas/PredictedClassDistribution'
          maxItems: 125
          type: array
        rowCountTotal:
          description: The number of rows in the bucket.
          type: integer
        rowCountWithActual:
          description: The number of prediction rows in the bucket with associated
            actuals.
          type: integer
      required:
      - hexagon
      - rowCountTotal
      - rowCountWithActual
      type: object
      x-versionadded: v2.35
    PredictionsVsActualsOverSpaceResponse:
      properties:
        baselines:
          description: The predictions vs. actuals over space baselines.
          items:
            $ref: '#/components/schemas/PredictionsVsActualsOverSpaceBucket'
          maxItems: 1000
          type: array
        buckets:
          description: The predictions vs. actuals over space buckets.
          items:
            $ref: '#/components/schemas/PredictionsVsActualsOverSpaceBucket'
          maxItems: 1000
          type: array
        geoFeatureName:
          description: The name of the geospatial feature.
          type: string
        modelId:
          description: 'The ID of the model for which metrics are being retrieved. '
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
        summary:
          $ref: '#/components/schemas/PredictionsVsActualsSummaryBucket'
      required:
      - baselines
      - buckets
      - geoFeatureName
      - summary
      type: object
      x-versionadded: v2.35
    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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/PredictionsVsActualsSummaryBucket'
      required:
      - baselines
      - buckets
      - summary
      type: object
    PredictionsVsActualsSummaryBucket:
      description: Predictions vs actuals summary.
      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'
          type: array
        meanActualValue:
          description: Mean actual value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        modelId:
          description: ID of the model.
          type: string
        period:
          $ref: '#/components/schemas/BatchPeriod'
        predictedClassDistribution:
          description: Class distribution for all rows with actual in the bucket,
            only for classification deployments.
          items:
            $ref: '#/components/schemas/PredictedClassDistribution'
          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
          - 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:
      description: Each item has the country code and the full name of the corresponding
        country
      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'
          type: array
        next:
          description: A URL pointing to the next page (if `null`, there is no next
            page).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if `null`, there is no
            previous page).
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    PrepareForDeployment:
      properties:
        modelId:
          description: The model to prepare for deployment.
          type: string
      required:
      - modelId
      type: object
    PreviewPermadeleteStatus:
      description: Preview report id and associated status.
      properties:
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        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: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      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: Indicates whether the requested model is a valid input for
            creating a Prime model.
          type: boolean
        message:
          description: May contain details about why a model is not eligible for DataRobot
            Prime.
          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:
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          type:
          - string
          - 'null'
          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.
          type: object
        modelCategory:
          description: Indicates the type 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 the 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: 0
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          type:
          - integer
          - 'null'
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          type:
          - string
          - 'null'
        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: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
        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 model's 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: 100
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          type:
          - string
          - 'null'
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          type:
          - string
          - 'null'
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          type:
          - string
          - 'null'
      required:
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      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: The 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
    ProbeConfig:
      additionalProperties: false
      properties:
        failureThreshold:
          default: 3
          description: Minimum consecutive failures for the probe to be considered
            failed
          title: Failurethreshold
          type: integer
        host:
          anyOf:
          - minLength: 0
            type: string
          - type: 'null'
          description: Host name to connect to, defaults to the pod IP.
          title: Host
        httpHeaders:
          additionalProperties:
            type: string
          description: HTTP headers for probe
          title: Httpheaders
          type: object
        initialDelaySeconds:
          default: 30
          description: Number of seconds to wait before the first probe is executed
          title: Initialdelayseconds
          type: integer
        path:
          description: URL path to query for health check
          title: Path
          type: string
        periodSeconds:
          default: 30
          description: How often (in seconds) to perform the probe
          title: Periodseconds
          type: integer
        port:
          default: 8080
          description: Port number to access on the container.
          maximum: 65535.0
          minimum: 1.0
          title: Port
          type: integer
        scheme:
          default: HTTP
          description: Scheme to use for connecting to the host.
          enum:
          - HTTP
          - HTTPS
          title: Scheme
          type: string
        timeoutSeconds:
          default: 30
          description: Number of seconds after which the probe times out
          title: Timeoutseconds
          type: integer
      required:
      - path
      title: ProbeConfig
      type: object
    ProcessingLimits:
      description: Processing limits setting for the deployment.
      properties:
        interval:
          description: A time interval that is applied when calculating processing
            limits.
          enum:
          - hour
          - day
          - week
          type: string
      required:
      - interval
      type: object
    ProjectAdvancedOptionsResponse:
      description: Information related to the current model of the deployment.
      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
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.11
        downsampledMajorityRows:
          description: the total number of the majority rows available for modeling,
            or null for projects without smart downsampling
          type:
          - integer
          - 'null'
          x-versionadded: v2.5
        downsampledMinorityRows:
          description: the total number of the minority rows available for modeling,
            or null for projects without smart downsampling
          type:
          - integer
          - 'null'
          x-versionadded: v2.5
        eventsCount:
          description: the name of the event count column, if specified, otherwise
            null.
          type:
          - string
          - 'null'
          x-versionadded: v2.8
        exposure:
          description: the name of the exposure column, if specified.
          type:
          - string
          - 'null'
          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
          type:
          - number
          - 'null'
          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
          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.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
        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``.
          type:
          - boolean
          - 'null'
          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.
          type:
          - string
          - 'null'
      required:
      - blendBestModels
      - blueprintThreshold
      - defaultMonotonicDecreasingFeaturelistId
      - defaultMonotonicIncreasingFeaturelistId
      - downsampledMajorityRows
      - downsampledMinorityRows
      - majorityDownsamplingRate
      - onlyIncludeMonotonicBlueprints
      - prepareModelForDeployment
      - responseCap
      - 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/BasicCredentialsFields'
          - $ref: '#/components/schemas/S3CredentialsFields'
          - $ref: '#/components/schemas/OAuthCredentialsFields'
          - $ref: '#/components/schemas/SnowflakeKeyPairCredentialsFields'
          - $ref: '#/components/schemas/GcpCredentialsFields'
          - $ref: '#/components/schemas/DatabricksAccessTokenCredentialsFields'
          - $ref: '#/components/schemas/DatabricksServicePrincipalCredentialsFields'
          - $ref: '#/components/schemas/AzureServicePrincipalCredentialsFields'
          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'
        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
          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.
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.23
        partition:
          $ref: '#/components/schemas/ProjectPartitionResponse'
        positiveClass:
          description: if the project uses binary classification, the class designated
            to be the positive class.  Otherwise, null.
          type:
          - number
          - 'null'
        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
          - GeoPoint
          - VectorDatabase
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.23
        useCase:
          $ref: '#/components/schemas/UseCaseIdName'
          x-versionadded: v2.36
        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 .
          type:
          - string
          - 'null'
          x-versionadded: v2.5
        featureLineageId:
          description: The ID of the lineage for automatically generated features.
          type:
          - string
          - 'null'
          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)
          type:
          - number
          - 'null'
        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
          type:
          - boolean
          - 'null'
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            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
        lowerQuartile:
          description: Lower quartile point of EDA sample of the feature.
          oneOf:
          - description: Lower quartile point of EDA sample of the feature.
            type: string
          - description: Lower quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
        max:
          description: maximum value of the EDA sample of the feature.
          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
          - type: 'null'
        mean:
          description: arithmetic mean of the EDA sample of the feature.
          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
          - type: 'null'
        median:
          description: median of the EDA sample of the feature.
          oneOf:
          - description: median of the EDA sample of the feature.
            type: string
          - description: median of the EDA sample of the feature.
            type: number
          - type: 'null'
        min:
          description: minimum value of the EDA sample of the feature.
          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
          - type: 'null'
        multilabelInsights:
          $ref: '#/components/schemas/MultilabelInsightsResponse'
          x-versionadded: v2.24
        naCount:
          description: Number of missing values.
          type: integer
        name:
          description: The 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.
          oneOf:
          - description: standard deviation of EDA sample of the feature.
            type: string
          - description: standard deviation of EDA sample of the feature.
            type: number
          - type: 'null'
        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.
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.8
        uniqueCount:
          description: number of unique values
          type: integer
        upperQuartile:
          description: Upper quartile point of EDA sample of the feature.
          oneOf:
          - description: Upper quartile point of EDA sample of the feature.
            type: string
          - description: Upper quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
      required:
      - dateFormat
      - featureLineageId
      - featureType
      - id
      - importance
      - lowInformation
      - lowerQuartile
      - max
      - mean
      - median
      - min
      - naCount
      - name
      - projectId
      - stdDev
      - targetLeakage
      - targetLeakageReason
      - timeSeriesEligibilityReason
      - timeSeriesEligible
      - timeStep
      - timeUnit
      - upperQuartile
      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: The 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.
          type:
          - string
          - 'null'
        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'
      required:
      - jobId
      - summary
      type: object
    ProjectNukeJobStatusSummaryObject:
      description: Project permanent deletion status to count mapping.
      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
    ProjectNukeReportDownloadResponse:
      properties:
        data:
          description: The list of projects and associated deletion statuses.
          items:
            $ref: '#/components/schemas/ProjectPermadeleteDownloadStatus'
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.46
    ProjectOptions:
      description: Options for projects used to build new models.
      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
          type:
          - number
          - 'null'
        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
          - null
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
        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
          type:
          - number
          - 'null'
        validationType:
          description: The validation type for projects used to build new models.
          enum:
          - CV
          - TVH
          type: string
      type: object
    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/`.
      properties:
        cvHoldoutLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          - type: 'null'
          description: if a user partition column was used with cross validation,
            the value assigned to the holdout set
        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.
          type:
          - string
          - 'null'
        datetimePartitionColumn:
          description: if a datetime partition column was used, the name of the column
          type: string
        holdoutLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          - type: 'null'
          description: if a user partition column was used with train-validation-holdout
            split, the value assigned to the holdout set
        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
          type: array
        reps:
          description: if cross validation was used, the number of folds to use
          type:
          - number
          - 'null'
        trainingLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          - type: 'null'
          description: if a user partition column was used with train-validation-holdout
            split, the value assigned to the training set
        useTimeSeries:
          description: A boolean value indicating whether a time series project was
            created as opposed to a regular project using datetime partitioning.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.9
        userPartitionCol:
          description: if a user partition column was used, the name of the column
          type:
          - string
          - 'null'
        validationLevel:
          anyOf:
          - type: string
          - type: number
          - type: integer
          - type: 'null'
          description: if a user partition column was used with train-validation-holdout
            split, the value assigned to the validation set
        validationPct:
          description: if train-validation-holdout split was used, the percentage
            of the dataset used for the validation set
          type:
          - number
          - 'null'
        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
    ProjectPermadeleteDownloadStatus:
      properties:
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        project_id:
          description: Project ID.
          type: string
        status:
          description: The processing state of the project cleanup task.
          enum:
          - ABORTED
          - BLOCKED
          - COMPLETED
          - CREATED
          - ERROR
          - EXPIRED
          - INCOMPLETE
          - INITIALIZED
          - PAUSED
          - RUNNING
          type: string
      required:
      - message
      - project_id
      - status
      type: object
      x-versionadded: v2.46
    ProjectPermadeleteStatus:
      properties:
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        projectId:
          description: Project ID
          type: string
          x-versionadded: v2.46
        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'
        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
          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'
          type:
          - string
          - 'null'
        catalogId:
          description: The ID of the AI catalog entry used to create the project,
            or null if not created from the AI catalog.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        created:
          description: The time of project creation.
          format: date-time
          type: string
        externalTimeSeriesBaselineDatasetMetadata:
          $ref: '#/components/schemas/ExternalTSBaselineMetadata'
          x-versionadded: v2.24
        featureEngineeringPredictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.23
        partition:
          $ref: '#/components/schemas/Partition'
        positiveClass:
          description: If the project uses binary classification, the class designated
            to be the positive class.
          oneOf:
          - type: string
          - type: integer
          - type: 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.27
        segmentation:
          $ref: '#/components/schemas/ProjectSegmentationInfoResponse'
          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
          type:
          - string
          - 'null'
        unsupervisedMode:
          description: Indicates whether a project is unsupervised.
          type:
          - boolean
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.23
        useCase:
          $ref: '#/components/schemas/UseCaseIdName'
          x-versionadded: v2.36
        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
          type:
          - boolean
          - 'null'
          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'
          type: array
        created:
          description: DR-formatted datetime, null for legacy (before DR 6.0) db records.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        creatorFullName:
          description: Fullname or email of the user created this config. null for
            legacy (before DR 6.0) db records.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        creatorUserId:
          description: ID of the user created this config, null for legacy (before
            DR 6.0) db records.
          type:
          - string
          - 'null'
          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'
          type: array
        featurelistId:
          description: Id of the feature list.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        id:
          description: ID of the secondary datasets configuration.
          type: string
        isDefault:
          description: Secondary datasets config is default config or not.
          type:
          - boolean
          - 'null'
        name:
          description: Name of the secondary datasets config.
          type:
          - string
          - 'null'
        projectId:
          description: ID of the project.
          type:
          - string
          - 'null'
        projectVersion:
          description: DataRobot project version.
          type:
          - string
          - 'null'
        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: The name of the operation to perform on the project segment.
          enum:
          - restart
          type: string
      type: object
    ProjectSegmentUpdateResponse:
      properties:
        projectId:
          description: The 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:
      description: Segmentation info for the project.
      properties:
        parentProjectId:
          description: ID of the original project.
          type:
          - string
          - 'null'
        segment:
          description: Segment value.
          type:
          - string
          - 'null'
        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
    PromptSamplingStrategy:
      description: The prompt sampling strategy for the evaluation dataset configuration.
      enum:
      - random_without_replacement
      - first_n_rows
      title: PromptSamplingStrategy
      type: string
    PromptTemplateResponse:
      description: API response object for a single prompt template.
      properties:
        creationDate:
          description: Prompt template creation date (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: ID of the user who created this prompt template.
          title: creationUserId
          type: string
        description:
          description: Prompt template description.
          title: description
          type: string
        id:
          description: Prompt template ID.
          title: id
          type: string
        lastUpdateDate:
          description: Date of the most recent update of this prompt template (ISO
            8601 formatted).
          format: date-time
          title: lastUpdateDate
          type: string
        lastUpdateUserId:
          description: ID of the user that made the most recent update to this prompt
            template.
          title: lastUpdateUserId
          type: string
        name:
          description: Prompt template name.
          title: name
          type: string
        userName:
          description: Name of the user who created this prompt template.
          title: userName
          type: string
        versionCount:
          description: The number of versions associated with this prompt template.
          title: versionCount
          type: integer
      required:
      - id
      - name
      - description
      - creationDate
      - creationUserId
      - lastUpdateDate
      - lastUpdateUserId
      - userName
      - versionCount
      title: PromptTemplateResponse
      type: object
    PromptTemplateVersionResponse:
      description: API response object for a single prompt template version.
      properties:
        commitComment:
          description: Description of changes for this prompt template version.
          title: commitComment
          type: string
        creationDate:
          description: Prompt template version creation date (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationUserId:
          description: ID of the user who created this prompt template version.
          title: creationUserId
          type: string
        id:
          description: Prompt template version ID.
          title: id
          type: string
        promptTemplateId:
          description: Prompt template ID.
          title: promptTemplateId
          type: string
        promptText:
          description: The text of the prompt with variables enclosed in double curly
            brackets.
          title: promptText
          type: string
        userName:
          description: Name of the user who created this prompt template version.
          title: userName
          type: string
        variables:
          description: List of variables associated with this prompt template version.
          items:
            $ref: '#/components/schemas/Variable'
          title: variables
          type: array
        version:
          description: Version of this prompt template version.
          title: version
          type: integer
      required:
      - id
      - promptTemplateId
      - promptText
      - commitComment
      - version
      - variables
      - creationDate
      - creationUserId
      - userName
      title: PromptTemplateVersionResponse
      type: object
    PromptTemplatesSortQueryParam:
      description: Sort order values for listing prompt templates.
      enum:
      - name
      - -name
      - description
      - -description
      - creationDate
      - -creationDate
      - lastUpdateDate
      - -lastUpdateDate
      title: PromptTemplatesSortQueryParam
      type: string
    PromptTraceResponse:
      description: API response object for a single playground prompt trace.
      properties:
        chatId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the chat associated with the trace.
          title: chatId
        chatName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the chat associated with the trace.
          title: chatName
        chatPromptId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the chat prompt associated with the trace.
          title: chatPromptId
        citations:
          anyOf:
          - items:
              $ref: '#/components/schemas/Citation'
            type: array
          - type: 'null'
          description: The list of relevant vector database citations (in case of
            using a vector database).
          title: citations
        comparisonPromptId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the comparison prompts associated with the trace.
          title: comparisonPromptId
        confidenceScores:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: The confidence scores that measure the similarity between the
            prompt context and the prompt completion for the prompt associated with
            the trace.
          title: confidenceScores
        evaluationDatasetConfigurationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the evaluation dataset associated with the trace.
          title: evaluationDatasetConfigurationId
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The execution status of the prompt associated with the trace.
        llmBlueprintId:
          description: The ID of the LLM blueprint associated with the trace.
          title: llmBlueprintId
          type: string
        llmBlueprintName:
          description: The name of the LLM blueprint associated with the trace.
          title: llmBlueprintName
          type: string
        llmLicense:
          anyOf:
          - type: string
          - type: 'null'
          description: The usage license information for the LLM associated with the
            trace.
          title: llmLicense
        llmName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the LLM associated with the trace.
          title: llmName
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: The settings of the LLM associated with the trace.
          title: llmSettings
        llmVendor:
          anyOf:
          - type: string
          - type: 'null'
          description: The vendor of the LLM associated with the trace.
          title: llmVendor
        promptType:
          anyOf:
          - $ref: '#/components/schemas/PromptType'
          - type: 'null'
          description: The type of prompt, chat history awair or one time prompt.
        resultMetadata:
          anyOf:
          - $ref: '#/components/schemas/ResultMetadata'
          - type: 'null'
          description: The additional information about the prompt associated with
            the trace.
        resultText:
          anyOf:
          - type: string
          - type: 'null'
          description: The completion text of the prompt associated with the trace.
          title: resultText
        text:
          description: The text of the prompt associated with the trace.
          title: text
          type: string
        timestamp:
          description: The timestamp of the trace (ISO 8601 formatted).
          format: date-time
          title: timestamp
          type: string
        useCaseId:
          description: The ID of the use case associated with the trace.
          title: useCaseId
          type: string
        user:
          $ref: '#/components/schemas/DataRobotUser'
          description: The user associated with the trace.
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database associated with the trace.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettings'
          - type: 'null'
          description: The settings of the vector database associated with the trace.
        warning:
          anyOf:
          - type: string
          - type: 'null'
          description: The warning message for the prompt associated with the trace.
          title: warning
      required:
      - timestamp
      - user
      - chatPromptId
      - comparisonPromptId
      - useCaseId
      - llmBlueprintId
      - llmBlueprintName
      - llmName
      - llmVendor
      - llmLicense
      - llmSettings
      - chatName
      - chatId
      - vectorDatabaseId
      - vectorDatabaseSettings
      - citations
      - resultMetadata
      - resultText
      - confidenceScores
      - text
      - executionStatus
      - promptType
      - evaluationDatasetConfigurationId
      - warning
      title: PromptTraceResponse
      type: object
    PromptType:
      description: Determines whether chat history is submitted as context to the
        user prompt.
      enum:
      - CHAT_HISTORY_AWARE
      - ONE_TIME_PROMPT
      title: PromptType
      type: string
    ProtonFormatted:
      additionalProperties: false
      properties:
        artifactId:
          description: ID of the artifact deployed by this proton
          title: Artifactid
          type: string
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Created At
          type: string
        creator:
          anyOf:
          - $ref: '#/components/schemas/UserData'
          - type: 'null'
          description: Owner user details including ID, username and email
        endpoint:
          anyOf:
          - type: string
          - type: 'null'
          description: API endpoint to use to send service requests
          title: Endpoint
        id:
          description: Unique identifier of the entity
          title: ID
          type: string
        name:
          description: Name of the entity
          title: Name
          type: string
        role:
          anyOf:
          - $ref: '#/components/schemas/ProtonRole'
          - type: 'null'
          description: Role of the proton within its workload, either 'active' or
            'candidate'.
        runningSince:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Timestamp of when the proton entered RUNNING status
          title: Runningsince
        runtime:
          $ref: '#/components/schemas/WorkloadRuntime'
          description: Runtime configuration for this proton
        status:
          $ref: '#/components/schemas/ProtonStatus'
          description: Proton status
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updated At
          type: string
        workloadId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the workload this proton belongs to
          title: Workloadid
      required:
      - id
      - name
      - createdAt
      - updatedAt
      - status
      - artifactId
      title: ProtonFormatted
      type: object
    ProtonListResponse:
      additionalProperties: false
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/ProtonFormatted'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ProtonListResponse
      type: object
    ProtonRequestMetricOverTime:
      additionalProperties: false
      description: Proton request metric over time.
      properties:
        buckets:
          description: Time-bucketed metric values with flexible structure
          items:
            additionalProperties: true
            type: object
          title: Buckets
          type: array
        metric:
          $ref: '#/components/schemas/WorkloadStatsMetricName'
          description: Metric name being tracked
        summary:
          $ref: '#/components/schemas/Summary'
          description: Summary information for the metric
      required:
      - metric
      - summary
      title: ProtonRequestMetricOverTime
      type: object
    ProtonRequestStats:
      additionalProperties: false
      description: Proton request statistics with time period.
      properties:
        metrics:
          $ref: '#/components/schemas/RequestMetrics'
          description: Request metrics
        period:
          anyOf:
          - $ref: '#/components/schemas/Period'
          - type: 'null'
          description: Time period
      title: ProtonRequestStats
      type: object
    ProtonRole:
      enum:
      - active
      - candidate
      title: ProtonRole
      type: string
    ProtonStatus:
      enum:
      - unknown
      - submitted
      - initializing
      - provisioning
      - launching
      - running
      - suspended
      - warming
      - draining
      - interrupted
      - restarting
      - stopping
      - stopped
      - errored
      - terminated
      title: ProtonStatus
      type: string
    ProvidedDockerfile:
      additionalProperties: false
      description: User supplies a Dockerfile in the uploaded source code.
      properties:
        path:
          default: ./Dockerfile
          description: Relative path to the Dockerfile in the source code. Defaults
            to ./Dockerfile.
          title: Path
          type: string
        source:
          const: provided
          default: provided
          title: Source
          type: string
      title: ProvidedDockerfile
      type: object
    ProviderGuardStage:
      description: The data stage where the provider guard metric is acting upon.
      enum:
      - prompt
      - response
      title: ProviderGuardStage
      type: string
    ProviderGuardsMetadata:
      description: Info on the provider guard metrics.
      properties:
        name:
          description: The name of the provider guard metric.
          title: name
          type: string
        satisfyCriteria:
          description: Whether the configured provider guard metric satisfied its
            hidden internal guard criteria.
          title: satisfyCriteria
          type: boolean
        stage:
          $ref: '#/components/schemas/ProviderGuardStage'
        value:
          anyOf:
          - type: string
          - type: number
          - type: integer
          - type: 'null'
          description: The value of the provider guard metric.
          title: value
      required:
      - satisfyCriteria
      - name
      - value
      - stage
      title: ProviderGuardsMetadata
      type: object
    QuotaCapacity:
      description: Resource capacity
      properties:
        capacity:
          description: Capacity value
          maximum: 2147483647
          minimum: 0
          type: integer
        units:
          description: Capacity type
          enum:
          - requests
          - token
          type: string
      required:
      - capacity
      - units
      type: object
      x-versionadded: v2.42
    QuotaCreate:
      properties:
        capacity:
          $ref: '#/components/schemas/QuotaCapacity'
        defaultRules:
          description: List of default quota rules.
          items:
            $ref: '#/components/schemas/QuotaRule'
          maxItems: 100
          type: array
        policies:
          description: List of quota policies to overwrite quota, per specific consumer.
          items:
            $ref: '#/components/schemas/QuotaPolicy'
          maxItems: 10000
          type: array
        resourceId:
          description: The ID of the resource.
          type: string
        resourceType:
          description: Type of resource the quota applies to.
          enum:
          - deployment
          - workload
          type: string
        saturationThreshold:
          description: Saturation threshold.
          maximum: 1.0
          minimum: 0.0
          type:
          - number
          - 'null'
      required:
      - defaultRules
      - resourceId
      - resourceType
      type: object
      x-versionadded: v2.43
    QuotaListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of quotas
          items:
            $ref: '#/components/schemas/QuotaResponse'
          maxItems: 10000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.39
    QuotaPolicy:
      properties:
        consumerId:
          description: ID of the consumer
          type: string
        consumerName:
          description: Consumer name
          type:
          - string
          - 'null'
          x-versionadded: v2.39
        consumerType:
          description: Type of consumer
          enum:
          - deployment
          - user
          - usergroup
          type: string
        reserved:
          description: Reserved resource percentage
          maximum: 1.0
          minimum: 0.0
          type:
          - number
          - 'null'
          x-versionadded: v2.42
        rules:
          description: List of quota rules for this policy
          items:
            $ref: '#/components/schemas/QuotaRule'
          maxItems: 100
          type: array
      required:
      - consumerId
      - consumerType
      - rules
      type: object
      x-versionadded: v2.39
    QuotaResponse:
      properties:
        capacity:
          $ref: '#/components/schemas/QuotaCapacity'
          default: null
          x-versionadded: v2.42
        defaultRules:
          description: List of default quota rules
          items:
            $ref: '#/components/schemas/QuotaRule'
          maxItems: 100
          type: array
        id:
          description: Unique identifier for the quota
          type: string
        policies:
          description: List of quota policies to overwrite quota per specific consumer
          items:
            $ref: '#/components/schemas/QuotaPolicy'
          maxItems: 10000
          type: array
        resourceId:
          description: ID of the specific resource
          type: string
        resourceType:
          description: Type of resource the quota applies to
          enum:
          - deployment
          - workload
          type: string
        saturationThreshold:
          description: Saturation threshold to enable guaranteed quotas
          maximum: 1.0
          minimum: 0.0
          type:
          - number
          - 'null'
          x-versionadded: v2.42
        userId:
          description: ID of the user associated with the quota
          type: string
      required:
      - defaultRules
      - id
      - policies
      - resourceId
      - resourceType
      - userId
      type: object
      x-versionadded: v2.39
    QuotaRule:
      properties:
        limit:
          description: Maximum limit for the quota rule
          exclusiveMaximum: 9223372036854775808
          exclusiveMinimum: 0
          type: integer
        rule:
          description: Type of quota rule
          enum:
          - concurrentRequests
          - inputSequenceLength
          - requests
          - token
          type: string
        window:
          default: min
          description: Time window for the quota
          enum:
          - day
          - hour
          - min
          type: string
      required:
      - limit
      - rule
      type: object
      x-versionadded: v2.39
    QuotaTemplateListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of quota templates
          items:
            $ref: '#/components/schemas/QuotaTemplateResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.39
    QuotaTemplateResponse:
      properties:
        id:
          description: Unique identifier for the quota template
          type: string
        name:
          description: Name of the quota template
          type: string
        rules:
          description: List of quota rules in this template
          items:
            $ref: '#/components/schemas/QuotaRule'
          maxItems: 100
          type: array
      required:
      - id
      - name
      - rules
      type: object
      x-versionadded: v2.39
    QuotaUpdate:
      properties:
        capacity:
          $ref: '#/components/schemas/QuotaCapacity'
          x-versionadded: v2.42
        defaultRules:
          description: List of default quota rules
          items:
            $ref: '#/components/schemas/QuotaRule'
          maxItems: 100
          type: array
        policies:
          description: List of quota policies to overwrite quota per specific consumer
          items:
            $ref: '#/components/schemas/QuotaPolicy'
          maxItems: 10000
          type: array
        saturationThreshold:
          description: Saturation threshold
          maximum: 1.0
          minimum: 0.0
          type:
          - number
          - 'null'
          x-versionadded: v2.42
      type: object
      x-versionadded: v2.39
    RandomSampleArgumentsCreate:
      description: The interactive sampling config.
      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
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - skip
      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 rating table 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: The URL pointing to the next page (if null, there is no next
            page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page (if null, there is no
            previous page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    RatingTableModelDetailsResponse:
      properties:
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        hasFinetuners:
          description: Whether a model has fine tuners.
          type: boolean
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
        isAugmented:
          description: Whether a model was trained using augmentation.
          type: boolean
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        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: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        lifecycle:
          $ref: '#/components/schemas/ModelLifecycle'
          x-versionadded: v2.30
        linkFunction:
          description: The link function the final modeler uses in the blueprint.
            If no link function exists, returns null.
          type:
          - string
          - 'null'
          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.
          type: object
        modelCategory:
          description: Indicates the type 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 the 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: 0
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        nClusters:
          description: The number of clusters to use in the specified unsupervised
            clustering model. Only valid in unsupervised clustering projects.
          type:
          - integer
          - 'null'
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          type:
          - string
          - 'null'
        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: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
        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: 100
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingDuration:
          description: the duration spanned by the dates in the partition column for
            the data used to train the model
          type:
          - string
          - 'null'
        trainingEndDate:
          description: the end date of the dates in the partition column for the data
            used to train the model
          format: date-time
          type:
          - string
          - 'null'
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        trainingStartDate:
          description: the start date of the dates in the partition column for the
            data used to train the model
          format: date-time
          type:
          - string
          - 'null'
      required:
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - 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 job ID 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 job ID 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:
      description: Information on why the capability is unsupported for the model.
      properties:
        supportsAccuracyOverTime:
          description: If present, the reason why Accuracy Over Time plots cannot
            be generated for the model.
          type: string
          x-versionadded: v2.34
        supportsAnomalyAssessment:
          description: If present, the reason why the Anomaly Assessment insight cannot
            be generated for the model.
          type: string
          x-versionadded: v2.34
        supportsAnomalyOverTime:
          description: If present, the reason why Anomaly Over Time plots cannot be
            generated for the model.
          type: string
          x-versionadded: v2.34
        supportsClusterInsights:
          description: If present, the reason why Cluster Insights cannot be generated
            for the model.
          type: string
          x-versionadded: v2.34
        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
        supportsForecastAccuracy:
          description: If present, the reason why Forecast Accuracy plots cannot be
            generated for the model.
          type: string
          x-versionadded: v2.34
        supportsForecastVsActual:
          description: If present, the reason why Forecast vs Actual plots cannot
            be generated for the model.
          type: string
          x-versionadded: v2.34
        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
        supportsPeriodAccuracy:
          description: If present, the reason why Period Accuracy insights cannot
            be generated for the model.
          type: string
          x-versionadded: v2.34
        supportsPredictionExplanations:
          description: If present, the reason why Prediction Explanations cannot be
            computed for the model.
          type: string
          x-versionadded: v2.34
        supportsPredictionIntervals:
          description: If present, the reason why Prediction Intervals cannot be computed
            for the model.
          type: string
          x-versionadded: v2.34
        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
        supportsSeriesInsights:
          description: If present, the reason why Series Insights cannot be generated
            for the model.
          type: string
          x-versionadded: v2.34
        supportsStability:
          description: If present, the reason why Stability plots cannot be generated
            for the model.
          type: string
          x-versionadded: v2.34
      type: object
    RecipeDownsamplingUpdate:
      properties:
        downsampling:
          $ref: '#/components/schemas/OneOfDownsamplingDirective'
          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
          - postgres
          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'
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
        recipeType:
          default: wrangling
          description: Type of the recipe workflow.
          enum:
          - sql
          - wrangling
          type: string
          x-versionadded: v2.36
        useCaseId:
          description: ID of the Use Case associated with the recipe.
          type: string
          x-versionadded: v2.33
      required:
      - dataSourceType
      - dataStoreId
      - dialect
      - inputs
      - recipeType
      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
    RecipeInput:
      discriminator:
        propertyName: inputType
      oneOf:
      - properties:
          alias:
            description: The alias for the data source table.
            maxLength: 256
            type:
            - string
            - 'null'
          dataSourceId:
            description: The ID of the input data source.
            type:
            - string
            - 'null'
          dataStoreId:
            description: The ID of the input data store.
            type:
            - string
            - 'null'
          datasetId:
            description: The ID of the input dataset.
            type:
            - string
            - 'null'
          inputType:
            description: The data that comes from a database connection.
            enum:
            - datasource
            type: string
          sampling:
            $ref: '#/components/schemas/SampleDirectiveCreate'
            default: null
        required:
        - inputType
        type: object
      - properties:
          alias:
            description: The alias for the data source table.
            maxLength: 256
            type:
            - string
            - 'null'
          datasetId:
            description: The ID of the input dataset.
            type: string
          datasetVersionId:
            description: The version ID of the input dataset.
            type:
            - string
            - 'null'
          inputType:
            description: The data that comes from the Data Registry.
            enum:
            - dataset
            type: string
          sampling:
            $ref: '#/components/schemas/SampleDirectiveCreate'
            default: null
          snapshotPolicy:
            description: Snapshot policy to use for this input.
            enum:
            - fixed
            - latest
            type: string
        required:
        - datasetId
        - inputType
        type: object
      x-versionadded: v2.35
    RecipeInputResponse:
      discriminator:
        propertyName: inputType
      oneOf:
      - properties:
          alias:
            description: The alias for the data source table.
            maxLength: 256
            type:
            - string
            - 'null'
          dataSourceId:
            description: The ID of the input data source.
            type:
            - string
            - 'null'
          dataStoreId:
            description: The ID of the input data store.
            type:
            - string
            - 'null'
          datasetId:
            description: The ID of the input dataset.
            type:
            - string
            - 'null'
          inputType:
            description: The data that comes from a database connection.
            enum:
            - datasource
            type: string
          sampling:
            $ref: '#/components/schemas/SampleDirectiveCreate'
            default: null
        required:
        - alias
        - dataSourceId
        - dataStoreId
        - datasetId
        - inputType
        type: object
      - properties:
          alias:
            description: The alias for the data source table.
            maxLength: 256
            type:
            - string
            - 'null'
          datasetId:
            description: The ID of the input dataset.
            type: string
          datasetVersionId:
            description: The version ID of the input dataset.
            type:
            - string
            - 'null'
          inputType:
            description: The data that comes from the Data Registry.
            enum:
            - dataset
            type: string
          sampling:
            $ref: '#/components/schemas/SampleDirectiveCreate'
            default: null
          snapshotPolicy:
            description: Snapshot policy to use for this input.
            enum:
            - fixed
            - latest
            type: string
        required:
        - alias
        - datasetId
        - datasetVersionId
        - inputType
        - snapshotPolicy
        type: object
    RecipeInputStatsResponse:
      properties:
        alias:
          description: The alias for the data source table.
          maxLength: 256
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        columnCount:
          description: Number of features in original (not sampled) data source
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        connectionName:
          description: The user-friendly name of the data store.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        dataSourceId:
          description: The ID of the input data source.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        dataStoreId:
          description: The ID of the input data store.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        datasetId:
          description: The ID of the input data source.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        datasetVersionId:
          description: The ID of the input data source,
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        rowCount:
          description: Number of rows in original (not sampled) data source
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        sampling:
          $ref: '#/components/schemas/SampleDirectiveCreate'
          default: null
          x-versionadded: v2.36
        snapshotPolicy:
          description: Snapshot policy to use for this input.
          enum:
          - fixed
          - latest
          type: string
          x-versionadded: v2.36
        status:
          description: Input preparation status
          enum:
          - ABORTED
          - COMPLETED
          - ERROR
          - EXPIRED
          - INITIALIZED
          - RUNNING
          type: string
          x-versionadded: v2.33
      required:
      - alias
      - columnCount
      - connectionName
      - dataSourceId
      - dataStoreId
      - inputType
      - name
      - rowCount
      - status
      type: object
    RecipeInputUpdate:
      properties:
        inputs:
          description: List of data sources and their sampling configurations.
          items:
            $ref: '#/components/schemas/RecipeInput'
          maxItems: 1000
          minItems: 1
          type: array
      required:
      - inputs
      type: object
      x-versionadded: v2.35
    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
    RecipeOperationsUpdate:
      properties:
        force:
          default: false
          description: If `true` then operations are stored even if they contain errors
          type: boolean
        operations:
          description: List of directives to run for the recipe.
          items:
            $ref: '#/components/schemas/OneOfDirective'
          maxItems: 1000
          type: array
      required:
      - operations
      type: object
      x-versionadded: v2.35
    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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        resultSchema:
          description: JDBC result schema
          items:
            $ref: '#/components/schemas/DataStoreExtendedColumnNoKeysResponse'
          maxItems: 10000
          type: array
          x-versionadded: v2.33
        storedCount:
          description: The number of rows available for preview.
          minimum: 0
          type: integer
          x-versionadded: v2.37
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.33
      required:
      - byteSize
      - columns
      - data
      - estimatedSizeExceedsLimit
      - next
      - previous
      - resultSchema
      - storedCount
      - totalCount
      type: object
    RecipeResponse:
      properties:
        createdAt:
          description: ISO 8601-formatted date/time when the recipe was created.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          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
          - postgres
          type: string
          x-versionadded: v2.33
        downsampling:
          $ref: '#/components/schemas/OneOfDownsamplingDirective'
          x-versionadded: v2.33
        errorMessage:
          default: null
          description: Error message related to the specific operation
          type:
          - string
          - 'null'
          x-versionadded: v2.34
        failedOperationsIndex:
          default: null
          description: Index of the first operation where error appears.
          type:
          - integer
          - 'null'
          x-versionadded: v2.34
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        operations:
          description: List of transformations
          items:
            $ref: '#/components/schemas/OneOfDirective'
          maxItems: 1000
          type: array
          x-versionadded: v2.33
        originalDatasetId:
          description: The ID of the dataset used to create the recipe.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        recipeId:
          description: The ID of the recipe.
          type: string
          x-versionadded: v2.33
        recipeType:
          description: Type of the recipe workflow.
          enum:
          - sql
          - Sql
          - SQL
          - wrangling
          - Wrangling
          - WRANGLING
          - featureDiscovery
          - FeatureDiscovery
          - FEATURE_DISCOVERY
          - featureDiscoveryPrivatePreview
          - FeatureDiscoveryPrivatePreview
          - FEATURE_DISCOVERY_PRIVATE_PREVIEW
          type: string
          x-versionadded: v2.33
        settings:
          $ref: '#/components/schemas/RecipeSettingsResponse'
          x-versionadded: v2.33
        sql:
          description: Recipe SQL query.
          maxLength: 320000
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        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
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          x-versionadded: v2.33
      required:
      - createdAt
      - createdBy
      - description
      - dialect
      - downsampling
      - errorMessage
      - failedOperationsIndex
      - inputs
      - name
      - operations
      - originalDatasetId
      - recipeId
      - recipeType
      - settings
      - sql
      - status
      - updatedAt
      - updatedBy
      type: object
    RecipeRunPreviewAsync:
      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
        numberOfOperationsToUse:
          description: The number indicating how many operations from the beginning
            to compute a preview for.
          minimum: 0
          type: integer
          x-versionadded: v2.35
      type: object
      x-versionadded: v2.35
    RecipeSettingsResponse:
      description: Recipe settings reusable at a modeling stage.
      properties:
        featureDiscoveryProjectId:
          description: Associated feature discovery project ID.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        featureDiscoverySupervisedFeatureReduction:
          default: null
          description: Run supervised feature reduction for Feature Discovery.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.34
        predictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        relationshipsConfigurationId:
          description: Associated relationships configuration ID.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        sparkInstanceSize:
          default: small
          description: The Spark instance size to use, if applicable.
          enum:
          - small
          - medium
          - large
          type: string
          x-versionadded: v2.38
        target:
          description: The feature to use as the target at the modeling stage.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        weightsFeature:
          description: The weights feature.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
      required:
      - featureDiscoveryProjectId
      - featureDiscoverySupervisedFeatureReduction
      - predictionPoint
      - relationshipsConfigurationId
      - sparkInstanceSize
      type: object
    RecipeSettingsUpdate:
      properties:
        featureDiscoverySupervisedFeatureReduction:
          description: Run supervised feature reduction for Feature Discovery.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.34
        predictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        relationshipsConfigurationId:
          description: '[Deprecated] No effect. The relationships configuration ID
            field is immutable.'
          type:
          - string
          - 'null'
          x-versionadded: v2.33
          x-versiondeprecated: v2.34
        sparkInstanceSize:
          default: small
          description: The Spark instance size to use, if applicable.
          enum:
          - small
          - medium
          - large
          type: string
          x-versionadded: v2.38
        target:
          description: The feature to use as the target at the modeling stage.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        weightsFeature:
          description: The weights feature.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
      type: object
    RecipesListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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
    RecommendedSetting:
      properties:
        hint:
          description: An optional hint for the setting.
          maxLength: 255
          type:
          - string
          - 'null'
        label:
          description: The label of the setting.
          maxLength: 80
          type: string
        setting:
          description: The internal name of the setting.
          maxLength: 30
          type: string
      required:
      - label
      - setting
      type: object
      x-versionadded: v2.38
    RecommendedSettingChoice:
      properties:
        label:
          description: The label of the setting.
          maxLength: 80
          type: string
        setting:
          description: The internal name of the setting.
          maxLength: 30
          type: string
      required:
      - label
      - setting
      type: object
      x-versionadded: v2.38
    RecommendedSettingItem:
      properties:
        hint:
          description: An optional hint for the setting.
          maxLength: 255
          type:
          - string
          - 'null'
        setting:
          description: The internal name of the setting.
          maxLength: 30
          type: string
      required:
      - setting
      type: object
      x-versionadded: v2.38
    RecommendedSettingsChoices:
      properties:
        data:
          description: The list of recommended settings.
          items:
            $ref: '#/components/schemas/RecommendedSettingChoice'
          maxItems: 20
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.38
    RecommendedSettingsResponse:
      properties:
        data:
          description: The list of recommended settings.
          items:
            $ref: '#/components/schemas/RecommendedSetting'
          maxItems: 20
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.38
    RecommendedSettingsUpdate:
      properties:
        data:
          description: The list of recommended settings to update.
          items:
            $ref: '#/components/schemas/RecommendedSettingItem'
          maxItems: 20
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.38
    RefinexInsightsResponse:
      properties:
        count:
          description: The 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: The status message.
          type: string
          x-versionadded: v2.33
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        status:
          description: The 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:
      description: Information on the creator of the registered model.
      properties:
        email:
          description: The email of the user who created the registered model.
          type: string
        id:
          description: The ID of the user who created the registered model.
          type: string
        name:
          description: The full name of the user who created the registered model.
          type:
          - string
          - 'null'
      required:
      - email
      - id
      - name
      type: object
    RegisteredModelDeploymentResponse:
      properties:
        createdAt:
          description: Deployment creation date
          type: string
        createdBy:
          $ref: '#/components/schemas/UserMetadata'
        currentlyDeployed:
          description: Whether version of this registered model is currently deployed
          type: boolean
        firstDeployedAt:
          description: When version of this registered model was first deployed
          type:
          - string
          - 'null'
        firstDeployedBy:
          $ref: '#/components/schemas/UserMetadata'
        id:
          description: The 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
          type:
          - string
          - 'null'
        predictionEnvironment:
          $ref: '#/components/schemas/DeploymentPredictionEnvironmentResponse'
        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: The number of items returned on this page.
          type: integer
        data:
          description: The list of formatted deployments.
          items:
            $ref: '#/components/schemas/RegisteredModelDeploymentResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RegisteredModelListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of formatted registered models.
          items:
            $ref: '#/components/schemas/RegisteredModelResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RegisteredModelResponse:
      properties:
        createdAt:
          description: The date when the registered model was created.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/RegisteredModelCreatedBy'
        description:
          description: The description of the registered model.
          type:
          - string
          - 'null'
        id:
          description: The 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: The latest version associated with this registered model.
          type: integer
        modifiedAt:
          description: The date when the registered model was last modified.
          format: date-time
          type: string
        modifiedBy:
          $ref: '#/components/schemas/UserMetadata'
        name:
          description: The name of the registered model.
          type: string
        target:
          $ref: '#/components/schemas/RegisteredModelTarget'
      required:
      - createdAt
      - createdBy
      - id
      - isArchived
      - lastVersionNum
      - modifiedAt
      - modifiedBy
      - name
      - target
      type: object
    RegisteredModelTarget:
      description: Information on the target variable.
      properties:
        name:
          description: The name of the target variable.
          type:
          - string
          - 'null'
        type:
          description: The type of the target variable.
          type:
          - string
          - 'null'
      required:
      - name
      - type
      type: object
    RegisteredModelUpdate:
      properties:
        description:
          description: The 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: The name of the registered model.
          maxLength: 1024
          type: string
      type: object
    RegisteredModelVersionsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of formatted registered model versions.
          items:
            $ref: '#/components/schemas/ModelPackageRetrieveResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RelatedEntitiesResponse:
      additionalProperties: false
      description: Response containing related entities.
      properties:
        count:
          default: 0
          description: Total number of related entities
          title: Count
          type: integer
        data:
          description: List of related entities
          items:
            anyOf:
            - $ref: '#/components/schemas/RelatedItem'
            - $ref: '#/components/schemas/RelatedItemID'
          title: Data
          type: array
      title: RelatedEntitiesResponse
      type: object
    RelatedItem:
      additionalProperties: false
      description: Related entity item.
      properties:
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Created At
          type: string
        creator:
          anyOf:
          - $ref: '#/components/schemas/UserData'
          - type: 'null'
          description: Owner user details including ID, username and email
          title: Creator
        id:
          description: Unique identifier of the entity
          title: ID
          type: string
        name:
          description: Name of the entity
          title: Name
          type: string
        permissions:
          $ref: '#/components/schemas/ResourcePermissions'
          description: User permissions for this related entity
        type:
          $ref: '#/components/schemas/ResourceTypes'
          description: Type of the related entity
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updated At
          type: string
      required:
      - id
      - name
      - createdAt
      - updatedAt
      - type
      title: RelatedItem
      type: object
    RelatedItemID:
      additionalProperties: false
      description: Basic information about a related entity, identified by its ID
        and type.
      properties:
        id:
          description: Unique identifier of the entity
          title: Id
          type: string
        type:
          $ref: '#/components/schemas/ResourceTypes'
          description: Type of the related entity
      required:
      - id
      - type
      title: RelatedItemID
      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
          type:
          - string
          - 'null'
        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: 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: The list of feature derivation window definitions that will
            be used.
          items:
            $ref: '#/components/schemas/FeatureDerivationWindow'
          maxItems: 3
          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: 0
          maximum: 30
          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'
          maxItems: 30
          type: array
        datetimePartitionColumn:
          description: If a datetime partition column was used, the name of the column.
          type:
          - string
          - 'null'
        featureEngineeringPredictionPoint:
          description: The date column to be used as the prediction point for time-based
            feature engineering.
          type:
          - string
          - 'null'
        relationshipsConfiguration:
          $ref: '#/components/schemas/RelationshipsConfigPayload'
        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'
        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: The 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: The 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
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
        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: 0
          type:
          - integer
          - 'null'
        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
          type:
          - string
          - 'null'
        featureDerivationWindows:
          description: The 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: 0
          maximum: 30
          type:
          - integer
          - 'null'
        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
          type:
          - string
          - 'null'
      required:
      - dataset1Identifier
      - dataset1Keys
      - dataset2Identifier
      - dataset2Keys
      type: object
    RelationshipsConfigCreate:
      properties:
        datasetDefinitions:
          description: The 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: The 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: The list of relationships between datasets specified in datasetDefinitions.
          items:
            $ref: '#/components/schemas/Relationship'
          type: array
      required:
      - datasetDefinitions
      - relationships
      type: object
    RelationshipsConfigPayload:
      description: Object describing how secondary datasets are related to the primary
        dataset
      properties:
        datasetDefinitions:
          description: The list of datasets.
          items:
            $ref: '#/components/schemas/DatasetDefinition'
          maxItems: 30
          minItems: 1
          type: array
        featureDiscoveryMode:
          description: Mode of feature discovery. Supported values are 'default' and
            'manual'.
          enum:
          - default
          - manual
          type:
          - string
          - 'null'
        featureDiscoverySettings:
          description: The list of feature discovery settings used to customize the
            feature discovery process.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySettingResponse'
          maxItems: 100
          type: array
        id:
          description: Id of the relationship configuration
          type: string
        relationships:
          description: The list of relationships.
          items:
            $ref: '#/components/schemas/Relationship'
          maxItems: 70
          minItems: 1
          type: array
        snowflakePushDownCompatible:
          description: Flag indicating if the relationships configuration is compatible
            with Snowflake push down processing.
          type:
          - boolean
          - 'null'
      required:
      - datasetDefinitions
      - id
      - relationships
      type: object
    RelationshipsConfigResponse:
      properties:
        datasetDefinitions:
          description: The 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
          type:
          - string
          - 'null'
        featureDiscoverySettings:
          description: The list of feature discovery settings used to customize the
            feature discovery process.
          items:
            $ref: '#/components/schemas/FeatureDiscoverySettingResponse'
          type: array
        id:
          description: ID of relationships configuration.
          type: string
        relationships:
          description: The list of relationships between datasets specified in datasetDefinitions.
          items:
            $ref: '#/components/schemas/RelationshipResponse'
          type: array
        snowflakePushDownCompatible:
          description: Is this configuration compatible with pushdown computation
            on Snowflake?
          type:
          - boolean
          - 'null'
      required:
      - datasetDefinitions
      - relationships
      type: object
    RemoteEventCreate:
      properties:
        data:
          $ref: '#/components/schemas/RemoteEventData'
        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
          - moderationMetricCreationError
          - moderationMetricReportingError
          - moderationModelConfigError
          - moderationModelModerationCompleted
          - moderationModelModerationStarted
          - moderationModelPostScorePhaseCompleted
          - moderationModelPostScorePhaseStarted
          - moderationModelPreScorePhaseCompleted
          - moderationModelPreScorePhaseStarted
          - moderationModelRuntimeError
          - moderationModelScoringCompleted
          - moderationModelScoringError
          - moderationModelScoringStarted
          - 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'
        message:
          description: Descriptive message for health events.
          maxLength: 16384
          type: string
        moderationData:
          $ref: '#/components/schemas/ModerationData'
          x-versionadded: v2.35
        orgId:
          description: The identifier of the organization associated with the event.
          type:
          - string
          - 'null'
        predictionEnvironmentId:
          description: The identifier of the prediction environment associated with
            the event.
          type: string
        predictionRequestData:
          $ref: '#/components/schemas/PredictionRemoteEventData'
        spoolerChannelData:
          $ref: '#/components/schemas/SpoolerChannelEventData'
        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:
      description: Event payload.
      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:
      description: The transformation description.
      properties:
        columnMappings:
          description: The list of name mappings.
          items:
            $ref: '#/components/schemas/RenameColumn'
          maxItems: 1000
          minItems: 1
          type: array
          x-versionadded: v2.33
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - columnMappings
      - skip
      type: object
    RenameFileOrFolderBody:
      properties:
        fromPath:
          description: The file or folder path to rename. Folder paths should end
            with "/".
          type: string
        overwrite:
          default: RENAME
          description: "How to deal with a name conflict with an existing file or\
            \ folder with the same name.\nRENAME (default): rename the file or folder\
            \ using \u201C<filename> (n).ext\u201D or \"<folder> (n)\" pattern.\n\
            REPLACE: prefer the renamed file or folder.\nSKIP: prefer the existing\
            \ file or folder.\nERROR: return \"HTTP 409 Conflict\" response in case\
            \ of a naming conflict. "
          enum:
          - rename
          - Rename
          - RENAME
          - replace
          - Replace
          - REPLACE
          - skip
          - Skip
          - SKIP
          - error
          - Error
          - ERROR
          type: string
        toPath:
          description: The new path for the file or folder. Folder paths should end
            with "/".
          type: string
      required:
      - fromPath
      - overwrite
      - toPath
      type: object
      x-versionadded: v2.42
    ReorderCellsRequest:
      description: Request payload values for reordering notebook cells.
      properties:
        actionId:
          description: Action ID of the notebook update request.
          maxLength: 64
          title: Actionid
          type: string
        cellIds:
          description: List of cell IDs to reorder.
          items:
            type: string
          title: Cellids
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - generation
      - path
      - cellIds
      title: ReorderCellsRequest
      type: object
    ReplaceDirectiveArguments:
      description: The transformation description.
      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
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - matchMode
      - origin
      - searchFor
      - skip
      type: object
    Replacement:
      additionalProperties: false
      description: Store replacement information for workloads.
      properties:
        candidateArtifactId:
          description: Candidate Artifact ID
          title: Candidateartifactid
          type: string
        candidateProtonIds:
          description: IDs of protons pending promotion during artifact replacement
          items:
            type: string
          title: Candidateprotonids
          type: array
        config:
          $ref: '#/components/schemas/ReplacementConfig'
          description: Configuration for the replacement process, including warmup
            duration and old version retention time
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Createdat
          type: string
        deletedAt:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Timestamp of when the entity was deleted
          title: Deletedat
        id:
          description: Unique identifier of the entity
          title: Id
          type: string
        isDeleted:
          default: false
          description: Whether this entity has been deleted
          title: Isdeleted
          type: boolean
        message:
          anyOf:
          - type: string
          - type: 'null'
          description: Additional information about the replacement status, such as
            validation errors or reasons for failure
          title: Message
        name:
          description: Name of the entity
          title: Name
          type: string
        previousProtonIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: IDs of protons pending decommissioning during artifact replacement
          title: Previousprotonids
        protonStatuses:
          anyOf:
          - additionalProperties:
              $ref: '#/components/schemas/ReplicaStatusesSnapshot'
            type: object
          - type: 'null'
          description: Latest known status of candidate protons, used to determine
            replacement status transitions
          title: Protonstatuses
        runtime:
          $ref: '#/components/schemas/WorkloadRuntime'
          description: Runtime for the workload; required if there is no active artifact
            for the workload
        status:
          $ref: '#/components/schemas/ReplacementStatus'
          default: unknown
          description: Replacement status
        strategy:
          $ref: '#/components/schemas/ReplacementStrategy'
          default: rolling
          description: Replacement strategy
        switchedAt:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Timestamp of when the replacement take action
          title: Switchedat
        tenantId:
          description: ID of the tenant this entity belongs to
          format: uuid4
          title: Tenantid
          type: string
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updatedat
          type: string
        userId:
          description: ID of the user who owns this entity
          title: Userid
          type: string
        workloadId:
          description: Workload ID
          title: Workloadid
          type: string
      required:
      - id
      - name
      - createdAt
      - updatedAt
      - userId
      - tenantId
      - workloadId
      - candidateArtifactId
      title: Replacement
      type: object
    ReplacementConfig:
      additionalProperties: false
      description: Configuration for workload replacement.
      properties:
        keepOldVersionMinutes:
          default: 0
          description: Duration in minutes to keep the old version during replacement
          title: Keepoldversionminutes
          type: integer
        warmupDurationMinutes:
          default: 0
          description: Duration in minutes for the warmup phase during replacement
          title: Warmupdurationminutes
          type: integer
      title: ReplacementConfig
      type: object
    ReplacementHistoryListResponse:
      additionalProperties: false
      description: Response model for listing replacement history of a workload.
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/Replacement'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: ReplacementHistoryListResponse
      type: object
    ReplacementStatus:
      description: Statuses for workload replacement process.
      enum:
      - unknown
      - submitted
      - initializing
      - staged
      - promoting
      - canceling
      - completed
      - errored
      - finalizing
      title: ReplacementStatus
      type: string
    ReplacementStrategy:
      description: "Types of replacement strategies.\n`rolling` - the new proton is\
        \ deployed alongside the old one, and trafic\n    is switched to the new proton\
        \ once it is ready. The old proton is then decommissioned."
      enum:
      - rolling
      title: ReplacementStrategy
      type: string
    ReplicaConditionDetail:
      additionalProperties: false
      properties:
        lastTransitionTime:
          title: Lasttransitiontime
          type: string
        message:
          default: ''
          title: Message
          type: string
        reason:
          default: ''
          title: Reason
          type: string
        type:
          title: Type
          type: string
        value:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Value
      required:
      - type
      - value
      - lastTransitionTime
      title: ReplicaConditionDetail
      type: object
    ReplicaDetail:
      additionalProperties: false
      properties:
        address:
          title: Address
          type: string
        conditions:
          items:
            $ref: '#/components/schemas/ReplicaConditionDetail'
          title: Conditions
          type: array
        containers:
          items:
            $ref: '#/components/schemas/ContainerStatusDetail'
          title: Containers
          type: array
        name:
          title: Name
          type: string
        nodeAddress:
          title: Nodeaddress
          type: string
        startedAt:
          anyOf:
          - type: string
          - type: 'null'
          title: Startedat
        status:
          $ref: '#/components/schemas/ReplicaPhase'
      required:
      - name
      - status
      - address
      - nodeAddress
      - startedAt
      - conditions
      - containers
      title: ReplicaDetail
      type: object
    ReplicaPhase:
      description: Lifecycle phase of a deployment replica.
      enum:
      - pending
      - running
      - succeeded
      - failed
      - unknown
      title: ReplicaPhase
      type: string
    ReplicaStatusesSnapshot:
      additionalProperties: false
      properties:
        overallStatus:
          $ref: '#/components/schemas/WorkloadMonitorOverallStatus'
        replicas:
          items:
            $ref: '#/components/schemas/ReplicaDetail'
          title: Replicas
          type: array
      required:
      - overallStatus
      - replicas
      title: ReplicaStatusesSnapshot
      type: object
    Repository:
      description: The repository the template is stored in.
      properties:
        branch:
          description: Optional branch name used when a tag is not provided.
          maxLength: 256
          type:
          - string
          - 'null'
          x-versionadded: v2.4
        isPublic:
          description: Sets whether the repository is public or requires authentication.
          type: boolean
        softPin:
          description: Optional semantic version constraint (for example, '~=1.1.0')
            used to resolve tags dynamically.
          maxLength: 256
          type:
          - string
          - 'null'
          x-versionadded: v2.4
        tag:
          description: A reference pointing to where to check out the repository,
            from either a branch or a commit SHA.
          maxLength: 256
          type:
          - string
          - 'null'
        url:
          description: The URL to the GitHub repository (e.g., https://github.com/my-org/my-project/).
          format: uri
          type: string
      required:
      - isPublic
      - url
      type: object
      x-versionadded: v2.35
    RequestMetrics:
      additionalProperties: false
      description: Detailed request metrics.
      properties:
        concurrentRequests:
          default: 0
          description: Current concurrent requests
          title: Concurrentrequests
          type: integer
        requestsPerMinute:
          default: 0
          description: Average requests per minute
          title: Requestsperminute
          type: integer
        responseTime:
          default: 0
          description: Average response time in milliseconds
          title: Responsetime
          type: integer
        serverErrorRate:
          default: 0.0
          description: Server error rate
          title: Servererrorrate
          type: number
        serverErrors:
          default: 0
          description: Number of server errors (5xx)
          title: Servererrors
          type: integer
        slowRequests:
          default: 0
          description: Number of slow requests exceeding threshold
          title: Slowrequests
          type: integer
        totalErrorRate:
          default: 0.0
          description: Total error rate
          title: Totalerrorrate
          type: number
        totalRequests:
          default: 0
          description: Total number of requests
          title: Totalrequests
          type: integer
        userErrorRate:
          default: 0.0
          description: User error rate
          title: Usererrorrate
          type: number
        userErrors:
          default: 0
          description: Number of user errors (4xx)
          title: Usererrors
          type: integer
      title: RequestMetrics
      type: object
    RequestNotification:
      description: The request that was sent in the notification.
      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
          type:
          - string
          - 'null'
      required:
      - body
      - headers
      - url
      type: object
    RequestStats:
      additionalProperties: false
      description: Request statistics summary.
      properties:
        concurrentRequests:
          default: 0
          description: Number of concurrent requests
          title: Concurrentrequests
          type: integer
        errorRate:
          default: 0.0
          description: Error rate percentage
          title: Errorrate
          type: number
        errorRates:
          description: Error rates over the last 7 time periods
          items:
            type: integer
          title: Errorrates
          type: array
        lastRequestAt:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Timestamp of the last request
          title: Lastrequestat
        requestRates:
          description: Request rates over the last 7 time periods
          items:
            type: integer
          title: Requestrates
          type: array
        responseTime:
          default: 0
          description: Average response time in milliseconds
          title: Responsetime
          type: integer
        totalRequests:
          default: 0
          description: Total number of requests
          title: Totalrequests
          type: integer
      title: RequestStats
      type: object
    RequiredMetadataKey:
      description: 'Define additional parameters required to assemble a model. Model
        versions using this environment must define values

        for each fieldName in the requiredMetadata.'
      properties:
        displayName:
          description: A human readable name for the required field.
          title: Displayname
          type: string
        fieldName:
          description: The required field key. This value is added as an environment
            variable when running custom models.
          title: Fieldname
          type: string
      required:
      - fieldName
      - displayName
      title: RequiredMetadataKey
      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: The number of items returned on this page.
          type: integer
        data:
          description: The list of residuals charts for the dataset.
          items:
            $ref: '#/components/schemas/ResidualsChartForDatasets'
          type: array
        modelId:
          description: The model ID.
          type: string
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
    ResolvedBundle:
      description: Bundle details returned in the runtime response after scheduling.
      properties:
        cpuCount:
          description: Number of CPU cores
          title: CPU Count
          type: number
        gpuCount:
          default: 0
          description: Number of GPU units
          title: GPU Count
          type: integer
        gpuMaker:
          anyOf:
          - type: string
          - type: 'null'
          description: GPU manufacturer
          title: GPU Maker
        gpuTypeLabel:
          anyOf:
          - type: string
          - type: 'null'
          description: GPU type label
          title: GPU Type Label
        id:
          description: Bundle identifier that was selected
          title: Id
          type: string
        memoryBytes:
          description: Memory size in bytes
          title: Memory Bytes
          type: integer
      required:
      - id
      - cpuCount
      - memoryBytes
      title: ResolvedBundle
      type: object
    Resource:
      description: The resource of the span.
      properties:
        attributes:
          additionalProperties:
            type: string
          description: The attributes of the resource.
          type: object
      required:
      - attributes
      type: object
      x-versionadded: v2.37
    ResourceAllocation:
      additionalProperties: false
      description: Per-container resource allocation declared at runtime.
      properties:
        cpu:
          anyOf:
          - minimum: 0.1
            type: number
          - type: 'null'
          description: CPU cores allocated to this container.
          title: Cpu
        gpu:
          anyOf:
          - minimum: 0.0
            type: number
          - type: 'null'
          description: GPUs allocated to this container.
          title: Gpu
        memory:
          anyOf:
          - pattern: ^\s*(\d*\.?\d+)\s*(\w+)?
            type: string
          - minimum: 0.0
            type: integer
          - type: 'null'
          description: "RAM allocated to this container. Accepts a human-readable\
            \ string with one of: B, KB, MB, GB (1000-based) \u2014 e.g. '8GB', '512MB'.\
            \ Also accepts raw byte integers."
          examples:
          - 8GB
          - 512MB
          title: Memory
      title: ResourceAllocation
      type: object
    ResourceCategoriesResponse:
      properties:
        data:
          description: The resource categories.
          items:
            $ref: '#/components/schemas/ResourceCategory'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.37
    ResourceCategory:
      properties:
        id:
          description: The identifier of the resource category
          type: string
        name:
          description: The display name of the resource category
          type: string
      required:
      - id
      - name
      type: object
      x-versionadded: v2.37
    ResourcePermission:
      description: Represents the particular role a user, group or organization holds
        on an entity.
      enum:
      - CAN_VIEW
      - CAN_UPDATE
      - CAN_DELETE
      - CAN_SHARE
      - CAN_MAKE_PREDICTIONS
      - CAN_SHARE_ROLE_OWNER
      - CAN_SHARE_ROLE_READ_WRITE
      - CAN_SHARE_ROLE_READ_ONLY
      title: ResourcePermission
      type: string
    ResourcePermissions:
      anyOf:
      - items:
          $ref: '#/components/schemas/ResourcePermission'
        type: array
      - items:
          $ref: '#/components/schemas/ANY_PERMISSION'
        type: array
    ResourceRequestBundleListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
          x-versionadded: v2.35
        data:
          description: List of bundles.
          items:
            $ref: '#/components/schemas/ResourceRequestBundleResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.35
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.35
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    ResourceRequestBundleResponse:
      properties:
        cpuCount:
          description: Max number of CPUs available.
          type: number
        description:
          description: A short description of CPU, Memory and other resources.
          type: string
        gpuCount:
          description: Max number of GPUs available.
          type:
          - number
          - 'null'
        gpuMaker:
          description: The manufacture of the GPU.
          enum:
          - nvidia
          - amd
          - intel
          type:
          - string
          - 'null'
        gpuMemoryBytes:
          description: Max amount of GPU memory available.
          type: integer
          x-versionadded: v2.36
        gpuTypeLabel:
          description: A label that identifies the GPU type.
          type:
          - string
          - 'null'
          x-versionadded: v2.4
        hasGpu:
          description: If this bundle provides at least one GPU resource.
          type: boolean
        id:
          description: The id of the bundle.
          type: string
        isBillable:
          default: false
          description: If the bundle has been billable or unbillable.
          type: boolean
          x-versionadded: v2.44
        isDefault:
          description: If this should be the default resource choice.
          type: boolean
        isDeleted:
          description: If the bundle has been deleted and should not be used.
          type: boolean
        memoryBytes:
          description: Max amount of memory available.
          type: integer
        name:
          description: A short name for the bundle.
          type: string
        scalingMetrics:
          description: List of scaling metrics supported by this bundle.
          items:
            type: string
          maxItems: 50
          type: array
          x-versionadded: v2.46
        useCases:
          description: List of use cases this bundle supports.
          items:
            enum:
            - customApplication
            - customJob
            - customModel
            - customTaskFit
            - modelingMachineWorker
            - predictionAPI
            - sapAICore
            - sparkApplication
            type: string
          type: array
      required:
      - cpuCount
      - description
      - gpuMemoryBytes
      - hasGpu
      - id
      - memoryBytes
      - name
      - useCases
      type: object
      x-versionadded: v2.35
    ResourceShare:
      properties:
        resourceId:
          description: ID of the resource to share with invited users.
          type: string
        resourceType:
          description: Resource type to share with invited users.
          enum:
          - app
          type: string
      required:
      - resourceId
      - resourceType
      type: object
      x-versionadded: v2.41
    ResourceTypes:
      enum:
      - artifact
      - artifact_repository
      - proton
      - workload
      - custom_model
      title: ResourceTypes
      type: string
    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.
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page.
          type:
          - string
          - 'null'
        usage:
          description: The resource usage records.
          items:
            $ref: '#/components/schemas/ResourceUsage'
          type: array
      required:
      - count
      - next
      - previous
      - usage
      type: object
    ResponseNotification:
      description: The response that was received after sending the notification.
      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
    ResultMetadata:
      description: The additional information about prompt execution results.
      properties:
        blockedResultText:
          anyOf:
          - type: string
          - type: 'null'
          description: The message to replace the result text if it is non empty,
            which represents a blocked response.
          title: blockedResultText
        cost:
          anyOf:
          - type: number
          - type: 'null'
          description: The estimated cost of executing the prompt.
          title: cost
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message for the prompt (in case of an errored prompt).
          title: errorMessage
        estimatedDocsTokenCount:
          default: 0
          description: The estimated number of tokens in the documents retrieved from
            the vector database.
          title: estimatedDocsTokenCount
          type: integer
        feedbackResult:
          $ref: '#/components/schemas/FeedbackResult'
          description: The user feedback associated with the prompt.
        finalPrompt:
          anyOf:
          - type: string
          - items:
              additionalProperties:
                anyOf:
                - type: string
                - items:
                    additionalProperties: true
                    type: object
                  type: array
                - type: 'null'
              type: object
            type: array
          - items:
              additionalProperties:
                anyOf:
                - type: string
                - items:
                    additionalProperties: true
                    type: object
                  type: array
              type: object
            type: array
          - additionalProperties:
              anyOf:
              - type: string
              - items:
                  additionalProperties:
                    type: string
                  type: object
                type: array
            type: object
          - type: 'null'
          description: The final representation of the prompt that was submitted to
            the LLM.
          title: finalPrompt
        inputTokenCount:
          default: 0
          description: The number of tokens in the LLM input. This number includes
            the tokens in the system prompt, the user prompt, the chat history (for
            history-aware chats) and the documents retrieved from the vector database
            (in case of using a vector database).
          title: inputTokenCount
          type: integer
        latencyMilliseconds:
          description: The latency of the LLM response (in milliseconds).
          title: latencyMilliseconds
          type: integer
        metrics:
          default: []
          description: The evaluation metrics for the prompt.
          items:
            $ref: '#/components/schemas/MetricMetadata'
          title: metrics
          type: array
        outputTokenCount:
          default: 0
          description: The number of tokens in the LLM output.
          title: outputTokenCount
          type: integer
        providerLLMGuards:
          anyOf:
          - items:
              $ref: '#/components/schemas/ProviderGuardsMetadata'
            type: array
          - type: 'null'
          description: The provider llm guards metadata.
          title: providerLLMGuards
        totalTokenCount:
          default: 0
          description: The combined number of tokens in the LLM input and output.
          title: totalTokenCount
          type: integer
      required:
      - latencyMilliseconds
      title: ResultMetadata
      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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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: 100
          exclusiveMinimum: 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: 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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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.
          exclusiveMinimum: 0.0
          maximum: 100.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
          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.
          exclusiveMinimum: 0
          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'
        customJobId:
          description: The ID of the custom job to be used in this policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        description:
          default: null
          description: Description of the retraining policy.
          maxLength: 10000
          type:
          - string
          - 'null'
        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
          - custom_job
          type: string
        name:
          description: Name of the retraining policy.
          maxLength: 512
          type: string
        projectOptions:
          $ref: '#/components/schemas/ProjectOptions'
        projectOptionsStrategy:
          description: Configure the project option strategy used for modeling.
          enum:
          - same_as_champion
          - override_champion
          - custom
          type: string
        timeSeriesOptions:
          $ref: '#/components/schemas/TimeSeriesOptions'
        trigger:
          $ref: '#/components/schemas/Trigger'
        useCaseId:
          description: The ID of the use case to be used in this policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
      required:
      - description
      - name
      type: object
    RetrainingPolicyListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of retraining policies.
          items:
            $ref: '#/components/schemas/RetrainingPolicyRetrieve'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        customJob:
          $ref: '#/components/schemas/CustomRetrainingJob'
          x-versionadded: v2.37
        description:
          description: Description of the retraining policy.
          type:
          - string
          - 'null'
        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'
        modelSelectionStrategy:
          description: Configure how new model is selected when the retraining policy
            runs.
          enum:
          - autopilot_recommended
          - same_blueprint
          - same_hyperparameters
          - custom_job
          type: string
        name:
          description: Name of the retraining policy.
          type: string
        projectOptions:
          $ref: '#/components/schemas/ProjectOptions'
        projectOptionsStrategy:
          description: Configure the project option strategy used for modeling.
          enum:
          - same_as_champion
          - override_champion
          - custom
          type: string
        timeSeriesOptions:
          $ref: '#/components/schemas/TimeSeriesOptions'
        trigger:
          $ref: '#/components/schemas/Trigger'
        useCase:
          $ref: '#/components/schemas/RetrainingUseCase'
          x-versionadded: v2.37
      required:
      - action
      - autopilotOptions
      - description
      - id
      - latestRun
      - modelSelectionStrategy
      - name
      - projectOptions
      - trigger
      type: object
    RetrainingPolicyRunListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrainingPolicyRunRetrieve:
      description: Latest run of the retraining policy.
      properties:
        challengerId:
          description: ID of the challenger created from this retraining policy run.
          type:
          - string
          - 'null'
        errorMessage:
          description: Error message of the retraining policy run.
          type:
          - string
          - 'null'
        finishTime:
          description: Finish time of the retraining policy run.
          format: date-time
          type:
          - string
          - 'null'
        id:
          description: ID of the retraining policy run.
          type:
          - string
          - 'null'
        modelPackageId:
          description: ID of the model package created from this retraining policy
            run.
          type:
          - string
          - 'null'
        projectId:
          description: ID of the project created from this retraining policy run.
          type:
          - string
          - 'null'
        registeredModelId:
          description: ID of the registered model associated with model package created
            from this retraining policy run
          type:
          - string
          - 'null'
        startTime:
          description: Start time of the retraining policy run.
          format: date-time
          type:
          - string
          - 'null'
        status:
          description: Status of the retraining policy run.
          type:
          - string
          - 'null'
        useCaseId:
          description: The ID of the Use Case associated with the model package created
            from this retraining policy run.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
      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'
        customJobId:
          description: The ID of the custom job to be used in this policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        description:
          description: Description of the retraining policy.
          maxLength: 10000
          type:
          - string
          - 'null'
        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
          - custom_job
          type: string
        name:
          description: Name of the retraining policy.
          maxLength: 512
          type: string
        projectOptions:
          $ref: '#/components/schemas/ProjectOptions'
        projectOptionsStrategy:
          description: Configure the project option strategy used for modeling.
          enum:
          - same_as_champion
          - override_champion
          - custom
          type: string
        timeSeriesOptions:
          $ref: '#/components/schemas/TimeSeriesOptions'
        trigger:
          $ref: '#/components/schemas/Trigger'
        useCaseId:
          description: The ID of the use case to be used in this policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
      type: object
    RetrainingSettingsRetrieve:
      properties:
        dataset:
          $ref: '#/components/schemas/Dataset'
        predictionEnvironment:
          $ref: '#/components/schemas/PredictionEnvironment'
        retrainingUser:
          $ref: '#/components/schemas/RetrainingUser'
      required:
      - dataset
      - predictionEnvironment
      - retrainingUser
      type: object
    RetrainingSettingsUpdate:
      properties:
        credentialId:
          description: ID of the credential used to refresh retraining dataset.
          type:
          - string
          - 'null'
        datasetId:
          description: ID of the retraining dataset.
          type:
          - string
          - 'null'
        predictionEnvironmentId:
          description: ID of the prediction environment to associate with the challengers
            created by retraining policies.
          type:
          - string
          - 'null'
        retrainingUserId:
          description: ID of the retraining user.
          type: string
      type: object
    RetrainingUseCase:
      description: The use case to link the retrained model to.
      properties:
        id:
          description: ID of the use case.
          type: string
        name:
          description: Name of the use case.
          type: string
      required:
      - id
      - name
      type: object
      x-versionadded: v2.37
    RetrainingUser:
      description: The user scheduled retraining will be performed on behalf of.
      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
    RetrievalMode:
      description: Retrieval modes for vector databases.
      enum:
      - similarity
      - maximal_marginal_relevance
      title: RetrievalMode
      type: string
    RetrieveConfusionMatrixPaginatedResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A list of paginated confusion matrix insights.
          items:
            $ref: '#/components/schemas/ConfusionMatrixInsightsSingleResponse'
          maxItems: 10
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.42
    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_oauth
          - azure_sas
          - azure_service_principal
          - basic
          - bearer
          - box_jwt
          - client_id_and_secret
          - databricks_access_token_account
          - databricks_service_principal_account
          - external_oauth_provider
          - gcp
          - oauth
          - rsa
          - s3
          - sap_oauth
          - 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'
        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
          - 'null'
        data:
          $ref: '#/components/schemas/FeatureEffectsInsightResponse'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of paginated feature effects insights.
          items:
            $ref: '#/components/schemas/RetrieveFeatureEffectsIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of paginated feature impact insights.
          items:
            $ref: '#/components/schemas/RetrieveFeatureImpactIndividualResponse'
          maxItems: 2
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of paginated lift chart insights.
          items:
            $ref: '#/components/schemas/RetrieveLiftChartIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    RetrievePredictionMetadataObject:
      properties:
        actualValueColumn:
          description: For time series unsupervised projects only. The actual value
            column can be used to calculate the classification metrics and insights.
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        datasetId:
          description: Deprecated alias for `predictionDatasetId`.
          type:
          - string
          - 'null'
        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).
          type:
          - string
          - 'null'
          x-versionadded: v2.21
        featureDerivationWindowCounts:
          description: For time series projects with partial history only. Indicates
            how many points were used during feature derivation.
          type:
          - integer
          - 'null'
          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
          type:
          - string
          - 'null'
          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.
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
        predictionIntervalsSize:
          description: For time series projects only. If prediction intervals were
            computed, what percentile they represent. Will be ``None`` if ``includePredictionIntervals``
            is ``False``.
          type:
          - integer
          - 'null'
        predictionThreshold:
          description: Threshold used for binary classification in predictions.
          type:
          - number
          - 'null'
          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
          type:
          - string
          - 'null'
          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
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        projectId:
          description: The project ID of the predictions.
          type: string
        shapWarnings:
          $ref: '#/components/schemas/ShapWarnings'
          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'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of paginated residuals insights.
          items:
            $ref: '#/components/schemas/RetrieveResidualsIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of paginated ROC curve insights.
          items:
            $ref: '#/components/schemas/RetrieveRocCurveIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RetrieveShapDistributionsIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/ShapDistributionsData'
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
        entityId:
          description: The ID of the model.
          type: string
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
        id:
          description: The ID of the created insight.
          type: string
        projectId:
          description: The ID of the project.
          type: string
        quickCompute:
          description: Whether the insight was computed using the quickCompute setting.
          type: boolean
          x-versionadded: v2.35
        source:
          description: The subset of data used to compute the insight.
          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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
      required:
      - data
      - id
      type: object
      x-versionadded: v2.35
    RetrieveShapDistributionsPaginatedResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of paginated SHAP distributions insights.
          items:
            $ref: '#/components/schemas/RetrieveShapDistributionsIndividualResponse'
          maxItems: 10
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    RetrieveShapImpactIndividualResponse:
      properties:
        data:
          $ref: '#/components/schemas/ShapImpactData'
          x-versionadded: v2.33
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        entityId:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        id:
          description: The ID of the created insight.
          type: string
          x-versionadded: v2.33
        projectId:
          description: The ID of the project.
          type: string
          x-versionadded: v2.33
        quickCompute:
          description: Whether the insight was computed using the quickCompute setting.
          type: boolean
          x-versionadded: v2.35
        source:
          description: Subset of data used to compute the insight.
          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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
          x-versionadded: v2.33
      required:
      - data
      - id
      type: object
    RetrieveShapImpactPaginatedResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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'
          x-versionadded: v2.33
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        entityId:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        id:
          description: The ID of the created insight.
          type: string
          x-versionadded: v2.33
        projectId:
          description: The ID of the project.
          type: string
          x-versionadded: v2.33
        quickCompute:
          description: Whether the insight was computed using the quickCompute setting.
          type: boolean
          x-versionadded: v2.35
        source:
          description: The subset of data used to compute the insight.
          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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
          x-versionadded: v2.33
      required:
      - data
      - id
      type: object
    RetrieveShapMatrixPaginatedResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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'
          x-versionadded: v2.33
        dataSliceId:
          description: The ID of the data slice.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        entityId:
          description: The ID of the model.
          type: string
          x-versionadded: v2.33
        externalDatasetId:
          description: The ID of the external dataset.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        id:
          description: The ID of the created insight.
          type: string
          x-versionadded: v2.33
        projectId:
          description: The ID of the project.
          type: string
          x-versionadded: v2.33
        quickCompute:
          description: Whether the insight was computed using the quickCompute setting.
          type: boolean
          x-versionadded: v2.35
        source:
          description: The subset of data used to compute the insight.
          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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          type: string
          x-versionadded: v2.33
      required:
      - data
      - id
      type: object
    RetrieveShapPreviewPaginatedResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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
    RetrieveUserLimitCounterResponse:
      description: API response object for retrieving user limit counters.
      properties:
        counter:
          description: The number of completed operations which count towards the
            usage limit.
          title: counter
          type: integer
      required:
      - counter
      title: RetrieveUserLimitCounterResponse
      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
          type:
          - string
          - 'null'
      required:
      - changeRequestId
      - changeVersionId
      - createdAt
      - id
      - status
      - userId
      - userName
      type: object
    ReviewsListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    RevisionActionSchema:
      description: Revision action information schema.
      properties:
        at:
          description: Action timestamp.
          format: date-time
          title: At
          type: string
        by:
          allOf:
          - $ref: '#/components/schemas/UserInfo'
          description: User who performed the action.
          title: By
      required:
      - at
      title: RevisionActionSchema
      type: object
    RevisionSupplementalMetadata:
      description: Supplemental metadata for a revision.
      properties:
        id:
          description: The ID of the revision.
          title: Id
          type: string
        name:
          description: The name of the revision.
          title: Name
          type: string
      required:
      - id
      - name
      title: RevisionSupplementalMetadata
      type: object
    RiskAssessmentComplete:
      description: Risk assessment defined as primary the current Use Case.
      properties:
        createdAt:
          description: The creation date of the risk assessment.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created the risk assessment.
          type: string
        description:
          description: The description of the risk assessment.
          type: string
        entityId:
          description: The ID of the entity.
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        entityType:
          description: The type of entity this assessment belongs to.
          maxLength: 255
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        evidence:
          description: The evidence for the risk assessment.
          type:
          - string
          - 'null'
        id:
          description: The ID of the risk assessment.
          type: string
        isPrimary:
          default: false
          description: Determines if the risk assessment is primary.
          type: boolean
        mitigationPlan:
          description: The mitigation plan for the risk assessment.
          type:
          - string
          - 'null'
        name:
          description: The name of the risk assessment.
          type: string
        policyId:
          description: The ID of the risk policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        riskDescription:
          description: The risk description for this assessment.
          maxLength: 10000
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        riskLevel:
          description: The name of the risk assessment level.
          type: string
        riskLevelId:
          description: The ID of the risk level within the policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        riskManagementPlan:
          description: The risk management plan.
          maxLength: 10000
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        score:
          description: The assessment score.
          type:
          - number
          - 'null'
          x-versionadded: v2.44
        tenantId:
          description: The tenant ID related to the risk assessment.
          type:
          - string
          - 'null'
        updatedAt:
          description: The last updated date of the risk assessment.
          format: date-time
          type: string
        updatedBy:
          description: The ID of the user who updated the risk assessment.
          type: string
      required:
      - createdAt
      - createdBy
      - description
      - entityId
      - entityType
      - evidence
      - id
      - isPrimary
      - mitigationPlan
      - name
      - policyId
      - riskDescription
      - riskLevelId
      - riskManagementPlan
      - score
      - tenantId
      - updatedAt
      - updatedBy
      type: object
      x-versionadded: v2.36
    RocCurveForDatasets:
      description: ROC curve data for datasets.
      properties:
        auc:
          description: The area under the curve (AUC).
          type:
          - number
          - 'null'
          x-versionadded: v2.43
        datasetId:
          description: The ID of the dataset that was used to compute the ROC curve.
          type: string
        kolmogorovSmirnovMetric:
          description: The Kolmogorv-Smirnov metric.
          type:
          - number
          - 'null'
          x-versionadded: v2.43
        negativeClassPredictions:
          description: The list of example predictions for the negative class.
          items:
            type: number
          maxItems: 100000000
          type: array
        positiveClassPredictions:
          description: The list of example predictions for the negative class.
          items:
            type: number
          maxItems: 100000000
          type: array
        rocPoints:
          description: The ROC curve data for that source, as specified below. Each
            point specifies how the model performed for a particular classification
            threshold.
          items:
            $ref: '#/components/schemas/RocPointsResponse'
          maxItems: 10000000
          type: array
      required:
      - auc
      - datasetId
      - kolmogorovSmirnovMetric
      - negativeClassPredictions
      - positiveClassPredictions
      - rocPoints
      type: object
    RocCurveForDatasetsList:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of ROC curve data for datasets.
          items:
            $ref: '#/components/schemas/RocCurveForDatasets'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    RocCurveResponse:
      description: ROC curve data.
      properties:
        auc:
          description: AUC value
          type:
          - number
          - 'null'
        kolmogorovSmirnovMetric:
          description: Kolmogorov-Smirnov metric value
          type:
          - number
          - 'null'
        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:
      description: ROC curve data for a single source.
      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
    RowsChunkDefinitionResponse:
      description: Row chunk definition properties.
      properties:
        datetimePartitionColumn:
          description: Date partition column name.
          type:
          - string
          - 'null'
        isDescendingOrder:
          default: false
          description: The sorting order.
          type: boolean
        orderByColumns:
          default: []
          description: The list of the sorting column names.
          items:
            description: Dataset column name.
            type: string
          maxItems: 10
          type: array
        otvEarliestTimestamp:
          description: The end date of training data in string format. Format can
            be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
            specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type:
          - string
          - 'null'
        otvLatestTimestamp:
          description: The end date of training data in string format. Format can
            be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
            specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type:
          - string
          - 'null'
        otvTrainingEndDate:
          description: The end date of training data in string format. Format can
            be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
            specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type:
          - string
          - 'null'
        otvValidationDownsamplingPct:
          description: Percent by which to downsample the validation data.
          type:
          - number
          - 'null'
        otvValidationEndDate:
          description: The end date of validation scoring data in string format. Format
            can be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults to UTC.When
            specifying `ValidationEndDate`, one must specify `ValidationStartDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type:
          - string
          - 'null'
        otvValidationStartDate:
          description: The start date of validation scoring data in string format.
            Format can be '%Y-%m-%d %H:%M%S' or '%Y-%m-%d', the timezone defaults
            to UTC.When specifying `ValidationStartDate`, one must specify `ValidationEndDate`.
            This attribute cannot be patched for non-OTV incremental learning projects.
          format: date-time
          type:
          - string
          - 'null'
        targetClass:
          description: Target Class.
          type:
          - string
          - 'null'
        targetColumn:
          description: Target column name.
          type:
          - string
          - 'null'
        userGroupColumn:
          description: User group column name.
          type:
          - string
          - 'null'
      required:
      - datetimePartitionColumn
      - isDescendingOrder
      - orderByColumns
      - otvEarliestTimestamp
      - otvLatestTimestamp
      - otvTrainingEndDate
      - otvValidationDownsamplingPct
      - otvValidationEndDate
      - otvValidationStartDate
      - targetClass
      - targetColumn
      - userGroupColumn
      type: object
      x-versionadded: v2.37
    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: The number of items returned on this page.
          type: integer
        data:
          description: Each item 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: The URL pointing to the next page (if null, there is no next
            page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page (if null, there is no
            previous page).
          format: uri
          type:
          - string
          - 'null'
      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
    RunAgenticSearchRequest:
      description: API request for run agentic search request.
      properties:
        evalDatasetId:
          description: The ID of the evaluation dataset.
          title: evalDatasetId
          type: string
        groundingDatasetId:
          description: The ID of the dataset the vector databases will be built from.
          title: groundingDatasetId
          type: string
        name:
          description: Name of the search study.
          title: name
          type: string
        numConcurrentTrials:
          description: The number of simultaneously running trials.
          title: numConcurrentTrials
          type: integer
        numTrials:
          description: The number of search trials to sample.
          title: numTrials
          type: integer
        optimizationObjectives:
          description: Optimization objectives of a study.
          items:
            maxItems: 2
            minItems: 2
            prefixItems:
            - $ref: '#/components/schemas/SearchObjective'
            - $ref: '#/components/schemas/SearchDirection'
            type: array
          title: optimizationObjectives
          type: array
        playgroundId:
          description: The ID of the existing playground that will be associated with
            the search.
          title: playgroundId
          type: string
        searchSpace:
          $ref: '#/components/schemas/SearchSpace'
          description: Search space for the search.
        useCaseId:
          description: The ID of the use case the search study is linked to.
          title: useCaseId
          type: string
      required:
      - useCaseId
      - playgroundId
      - groundingDatasetId
      - evalDatasetId
      - numTrials
      - numConcurrentTrials
      - optimizationObjectives
      - searchSpace
      - name
      title: RunAgenticSearchRequest
      type: object
    RunFileRequest:
      description: Request payload values for running a file.
      properties:
        commandArgs:
          description: 'Arguments and/or flags to pass to a file execution command.
            For example: ''--filename foo.txt -r'''
          title: Commandargs
          type: string
        commandType:
          allOf:
          - $ref: '#/components/schemas/RunnableCommandType'
          description: The type of command to be run. For example 'python'
        filePath:
          description: Path to the file to execute.
          title: Filepath
          type: string
      required:
      - filePath
      title: RunFileRequest
      type: object
    RunSearchApiResponse:
      description: API response object for run agentic search request.
      properties:
        jobId:
          description: The ID of the worker job.
          format: uuid4
          title: jobId
          type: string
        searchStudyId:
          description: The ID of the search study.
          title: searchStudyId
          type: string
      required:
      - searchStudyId
      - jobId
      title: RunSearchApiResponse
      type: object
    RunTypes:
      description: Types of runs that can be scheduled.
      enum:
      - scheduled
      - manual
      - pipeline
      title: RunTypes
      type: string
    RunnableCommandType:
      description: These are the command types/languages we support running files
        for.
      enum:
      - python
      - bash
      title: RunnableCommandType
      type: string
    RunnerStatuses:
      description: 'Runner is the same as kernel since it will manage multiple kernels
        in the future,

        We can''t consider kernel running if runner is not functioning and therefor
        this enum represents

        possible statuses of the kernel and runner sidecar functionality states.

        In the future this will likely be renamed to kernel.'
      enum:
      - not_started
      - starting
      - running
      - restarting
      - stopping
      - stopped
      - dead
      - deleted
      title: RunnerStatuses
      type: string
    RuntimeLanguage:
      description: Runtime language for notebook execution in the kernel.
      enum:
      - python
      - r
      - shell
      - markdown
      title: RuntimeLanguage
      type: string
    RuntimeParameterListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A unified view of the defined runtime parameters for this object,
            including the values that are currently set.
          items:
            $ref: '#/components/schemas/RuntimeParameterResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    RuntimeParameterReservedNamesData:
      description: The reserved runtime parameter name patterns and rules.
      properties:
        patterns:
          description: 'The list of reserved name patterns (supports wildcards: *
            and ?).'
          items:
            type: string
          type: array
      required:
      - patterns
      type: object
      x-versionadded: v2.44
    RuntimeParameterReservedNamesResponse:
      properties:
        data:
          $ref: '#/components/schemas/RuntimeParameterReservedNamesData'
      required:
      - data
      type: object
      x-versionadded: v2.44
    RuntimeParameterResponse:
      properties:
        allowEmpty:
          default: true
          description: Indicates whether the param must be set before registration
          type: boolean
        credentialType:
          description: The type of credential, required only for credentials parameters.
          enum:
          - adls_gen2_oauth
          - api_token
          - azure
          - azure_oauth
          - azure_sas
          - azure_service_principal
          - basic
          - bearer
          - box_jwt
          - client_id_and_secret
          - databricks_access_token_account
          - databricks_service_principal_account
          - external_oauth_provider
          - gcp
          - oauth
          - rsa
          - s3
          - sap_oauth
          - snowflake_key_pair_user_account
          - snowflake_oauth_user_account
          - tableau_access_token
          type:
          - string
          - 'null'
        currentValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          description: Given the default and the override, this is the actual current
            value of the parameter.
        defaultValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          description: The default value for the given field.
        description:
          description: Description how this parameter impacts the running model.
          type:
          - string
          - 'null'
        fieldName:
          description: The parameter name. This value will be added as an environment
            variable when running custom models.
          type: string
        keyValueId:
          description: The ID of the key value associated with a runtime parameter.
          type:
          - string
          - 'null'
        maxValue:
          description: The maximum value for a numeric field.
          type:
          - number
          - 'null'
        minValue:
          description: The minimum value for a numeric field.
          type:
          - number
          - 'null'
        overrideValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          description: Value set by the user that overrides the default set in the
            definition.
        type:
          description: The value type that the parameter accepts.
          enum:
          - boolean
          - credential
          - deployment
          - numeric
          - string
          type: string
      required:
      - fieldName
      - type
      type: object
      x-versionadded: v2.35
    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:
          - adls_gen2_oauth
          - api_token
          - azure
          - azure_oauth
          - azure_sas
          - azure_service_principal
          - basic
          - bearer
          - box_jwt
          - client_id_and_secret
          - databricks_access_token_account
          - databricks_service_principal_account
          - external_oauth_provider
          - gcp
          - oauth
          - rsa
          - s3
          - sap_oauth
          - snowflake_key_pair_user_account
          - snowflake_oauth_user_account
          - tableau_access_token
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        currentValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          description: Given the default and the override, this is the actual current
            value of the parameter.
          x-versionadded: v2.33
        defaultValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          description: The default value for the given field.
          x-versionadded: v2.33
        description:
          description: Description how this parameter impacts the running model.
          type:
          - string
          - 'null'
          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
        keyValueId:
          description: The ID of the key-value entry storing this parameter value.
          type:
          - string
          - 'null'
          x-versionadded: v2.41
        maxValue:
          description: The maximum value for a numeric field.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        minValue:
          description: The minimum value for a numeric field.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        overrideValue:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          description: Value set by the user that overrides the default set in the
            definition.
          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
    RuntimeParameterUpdate:
      properties:
        runtimeParameterValues:
          description: Inject values into a model at runtime. The fieldName must match
            a fieldName defined in the deployed model package. This list is merged
            with any existing runtime values.
          type: string
      required:
      - runtimeParameterValues
      type: object
      x-versionadded: v2.35
    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
            type:
            - string
            - 'null'
          - default: false
            description: The boolean value for the field (default False)
            type: boolean
          - default: null
            description: The numeric value for the field
            type:
            - number
            - 'null'
          description: The string, boolean or numeric value for the given field.
          x-versionadded: v2.33
      required:
      - fieldName
      - type
      - value
      type: object
    S3CredentialsFields:
      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
          x-versionadded: v2.20
        awsSecretAccessKey:
          description: The S3 AWS secret access key. Required if configId is not specified.Cannot
            include this parameter if configId is specified.
          type: string
          x-versionadded: v2.20
        awsSessionToken:
          default: null
          description: The S3 AWS session token for AWS temporary credentials.Cannot
            include this parameter if configId is specified.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        configId:
          description: The ID of secure configurations of credentials shared by admin.
            If specified, cannot include awsAccessKeyId, awsSecretAccessKey or awsSessionToken.
          type: string
          x-versionadded: v2.32
        credentialType:
          description: The type of these credentials, 's3' here.
          enum:
          - s3
          type: string
      required:
      - credentialType
      type: object
      x-versionadded: v2.46
    S3DataStreamer:
      description: Stream CSV data chunks from Amazon Cloud Storage S3
      properties:
        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
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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:
      description: Stream CSV data chunks from Amazon Cloud Storage S3
      properties:
        credentialId:
          description: Use the specified credential to access the url
          type:
          - string
          - 'null'
        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:
      description: Saves CSV data chunks to Amazon Cloud Storage S3
      properties:
        credentialId:
          description: Use the specified credential to access the url
          type:
          - string
          - 'null'
        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'
          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:
      description: Saves CSV data chunks to Amazon Cloud Storage S3
      properties:
        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
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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'
          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:
      description: An object containing SSO client advanced parameters.
      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'
        samlClientConfiguration:
          $ref: '#/components/schemas/EnhancedSamlClientConfig'
        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:
      description: Certificate to be used by IdP.
      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:
      description: XML document, IdP SSO descriptor. Provided by IdP service.
      properties:
        fileName:
          description: Path to IdP metadata file.
          type: string
        value:
          description: IdP metadata.
          type: string
      required:
      - fileName
      - value
      type: object
    SamlOrganizationMappingResponse:
      properties:
        datarobotOrganizationId:
          description: DataRobot organization ID.
          type: string
        datarobotOrganizationName:
          description: DataRobot organization name.
          type: string
        idpOrganizationId:
          description: A name of the identity provider organization.
          type: string
      required:
      - datarobotOrganizationId
      - idpOrganizationId
      type: object
      x-versionadded: v2.37
    SamlSecurityParameters:
      description: The object that contains SAML specific directives.
      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:
      description: Points to a weight column if users provide pre-aggregated metric
        values. Used with columnar datasets.
      properties:
        columnName:
          description: Column name
          type:
          - string
          - 'null'
      required:
      - columnName
      type: object
    SampleDirectiveCreate:
      description: The input data transformation steps.
      discriminator:
        propertyName: directive
      oneOf:
      - properties:
          arguments:
            $ref: '#/components/schemas/RandomSampleArgumentsCreate'
            default: {}
          directive:
            description: The directive name.
            enum:
            - random-sample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/DatetimeSampleArgumentsCreate'
            default: {}
          directive:
            description: The directive name.
            enum:
            - datetime-sample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/LimitDirectiveArguments'
          directive:
            description: The directive name.
            enum:
            - limit
            type: string
        required:
        - arguments
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/TableSampleArgumentsCreate'
            default: {}
          directive:
            description: The directive name.
            enum:
            - tablesample
            type: string
        required:
        - directive
        type: object
      - properties:
          arguments:
            $ref: '#/components/schemas/EfficientRowBasedSampleArgumentsCreate'
            default: {}
          directive:
            description: The directive name.
            enum:
            - efficient-rowbased-sample
            type: string
        required:
        - directive
        type: object
    SampleSection:
      type: object
    SampleSize:
      description: Ingest size to use during dataset registration. Default behavior
        is to ingest full dataset.
      properties:
        type:
          description: The 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: 0
          maximum: 1000000
          type: integer
          x-versionadded: v2.27
      required:
      - type
      - value
      type: object
    ScalingMetricType:
      oneOf:
      - const: cpuAverageUtilization
        description: Scale replicas to maintain a target average CPU utilization across
          pods.
        title: CPU Average Utilization
      - const: httpRequestsConcurrency
        description: Scale replicas based on HTTP request concurrency using an external
          HTTP-aware autoscaler. The platform manages the underlying autoscaling resources
          on your behalf. This scaling option will scale to zero replicas when the
          proton is idle.
        title: HTTP Requests Concurrency
      - const: gpuCacheUtilization
        description: Scales replicas based on model-specific GPU memory cache utilization.
          This signal reflects how the model's KV cache is used during inference,
          when such metrics are exposed by the serving runtime. High cache utilization
          may indicate memory pressure and can be used to trigger scale-out to maintain
          throughput. Applicable to NIM Artifacts only.
        title: GPU Cache Utilization
      - const: gpuRequestQueueDepth
        description: Scales replicas based on the depth of the inference request queue.
          This metric represents the number of incoming requests waiting to be processed
          by the inference service. Increasing queue depth may indicate insufficient
          capacity and can be used to trigger additional replicas to reduce latency.
          Applicable to NIM Artifacts only.
        title: GPU Request Queue Depth
      title: ScalingMetricType
      type: string
    Schedule:
      description: Data class that represents a cron schedule.
      properties:
        dayOfMonth:
          description: The day(s) of the month to run the schedule.
          items:
            anyOf:
            - type: integer
            - 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:
            - number
            - string
          maxItems: 31
          title: Dayofmonth
          type: array
        dayOfWeek:
          description: The day(s) of the week to run the schedule.
          items:
            anyOf:
            - type: integer
            - 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:
            - number
            - string
          maxItems: 7
          title: Dayofweek
          type: array
        hour:
          description: The hour(s) to run the schedule.
          items:
            anyOf:
            - type: integer
            - 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:
            - number
            - string
          maxItems: 24
          title: Hour
          type: array
        minute:
          description: The minute(s) to run the schedule.
          items:
            anyOf:
            - type: integer
            - 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:
            - number
            - string
          maxItems: 60
          title: Minute
          type: array
        month:
          description: The month(s) to run the schedule.
          items:
            anyOf:
            - type: integer
            - 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:
            - number
            - string
          maxItems: 12
          title: Month
          type: array
      required:
      - minute
      - hour
      - dayOfMonth
      - month
      - dayOfWeek
      title: Schedule
      type: object
    ScheduledHistoryListOrderBy:
      description: An enumeration.
      enum:
      - created
      - -created
      - title
      - -title
      - notebookName
      - -notebookName
      - runType
      - -runType
      - status
      - -status
      - startTime
      - -startTime
      - endTime
      - -endTime
      - duration
      - -duration
      - revisionName
      - -revisionName
      - environmentName
      - -environmentName
      - useCaseName
      - -useCaseName
      title: ScheduledHistoryListOrderBy
      type: string
    ScheduledJobListOrderBy:
      description: Fields to order the list of scheduled jobs by.
      enum:
      - title
      - -title
      - username
      - -username
      - notebookName
      - -notebookName
      - useCaseName
      - -useCaseName
      - status
      - -status
      - schedule
      - -schedule
      - lastRun
      - -lastRun
      - nextRun
      - -nextRun
      title: ScheduledJobListOrderBy
      type: string
    ScheduledJobParam:
      description: Parameter that is passed to the notebook when it is run as an environment
        variable.
      properties:
        name:
          description: Environment variable name.
          maxLength: 256
          pattern: ^[a-z-A-Z0-9_]+$
          title: Name
          type: string
        value:
          description: Environment variable value.
          maxLength: 131072
          title: Value
          type: string
      required:
      - name
      - value
      title: ScheduledJobParam
      type: object
    ScheduledJobPayload:
      description: Payload for the scheduled job.
      properties:
        notebookId:
          description: The ID of the notebook associated with the schedule.
          title: Notebookid
          type: string
        notebookName:
          description: The name of the notebook associated with the schedule.
          title: Notebookname
          type: string
        notebookPath:
          description: The path to the notebook in the file system if a Codespace
            is being used.
          title: Notebookpath
          type: string
        notebookType:
          allOf:
          - $ref: '#/components/schemas/NotebookType'
          default: plain
          description: The type of notebook.
        orgId:
          description: The ID of the organization the job is associated with.
          title: Orgid
          type: string
        parameters:
          description: The parameters to pass to the notebook when it runs.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
        runType:
          allOf:
          - $ref: '#/components/schemas/RunTypes'
          description: The run type of the job.
        uid:
          description: The ID of the user who created the job.
          title: Uid
          type: string
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
        useCaseName:
          description: The name of the use case this notebook is associated with.
          title: Usecasename
          type: string
      required:
      - uid
      - orgId
      - useCaseId
      - notebookId
      - notebookName
      title: ScheduledJobPayload
      type: object
    ScheduledJobQuery:
      description: Query parameters for a scheduled job.
      properties:
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      required:
      - useCaseId
      title: ScheduledJobQuery
      type: object
    ScheduledJobResponse:
      properties:
        createdBy:
          description: User name of the creator
          type:
          - string
          - 'null'
        deploymentId:
          description: ID of the deployment this scheduled job is created from.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        scheduledJobId:
          description: ID of this scheduled job.
          type: string
        status:
          $ref: '#/components/schemas/ScheduledJobStatus'
        typeId:
          description: Job type of the scheduled job
          type: string
        updatedAt:
          description: Time of last modification
          format: date-time
          type:
          - string
          - 'null'
      required:
      - enabled
      - id
      - schedule
      - scheduledJobId
      - status
      - typeId
      type: object
    ScheduledJobStatus:
      description: Object containing status information about the scheduled job.
      properties:
        lastFailedRun:
          description: Date and time of the last failed run.
          format: date-time
          type:
          - string
          - 'null'
        lastSuccessfulRun:
          description: Date and time of the last successful run.
          format: date-time
          type:
          - string
          - 'null'
        nextRunTime:
          description: Date and time of the next run.
          format: date-time
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
        running:
          description: '`true` or `false` depending on whether the job is currently
            running.'
          type: boolean
      required:
      - running
      type: object
    ScheduledJobsListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
    SearchDirection:
      description: Whether to minimize or maximize search objective.
      enum:
      - maximize
      - minimize
      title: SearchDirection
      type: string
    SearchObjective:
      description: List of supported search objectives.
      enum:
      - correctness
      - all_tokens
      title: SearchObjective
      type: string
    SearchSpace:
      description: Represents full search space.
      properties:
        chunkingParameters:
          $ref: '#/components/schemas/ChunkingParametersConfig'
          description: Chunking parameters for RAG.
        llmConfig:
          $ref: '#/components/schemas/LLMConfig'
          description: LLM configuration.
        vectorDatabaseSettings:
          $ref: '#/components/schemas/VectorDatabaseConfig'
          description: Vector database settings.
      title: SearchSpace
      type: object
    SearchStudyResponse:
      description: API response object for search study retrieval.
      properties:
        allTrials:
          anyOf:
          - items:
              $ref: '#/components/schemas/HistoryPoint'
            type: array
          - type: 'null'
          description: Trials history.
          title: allTrials
        datetimeEnd:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Study end time.
          title: datetimeEnd
        datetimeStart:
          description: Study start time.
          format: date-time
          title: datetimeStart
          type: string
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: Error message if search study fails.
          title: errorMessage
        evalDatasetId:
          description: The ID of the evaluation dataset.
          title: evalDatasetId
          type: string
        evalDatasetName:
          description: The name of evaluation dataset.
          title: evalDatasetName
          type: string
        evalResults:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          description: The results of the comparative evaluation of LLM blueprints.
          title: evalResults
        existingBlueprintIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The IDs of existing LLM blueprints for comparative evaluation.
          title: existingBlueprintIds
        groundingDatasetId:
          description: The ID of the dataset the vector databases will be built from.
          title: groundingDatasetId
          type: string
        groundingDatasetName:
          description: The name of the grouding dataset.
          title: groundingDatasetName
          type: string
        jobId:
          anyOf:
          - format: uuid4
            type: string
          - type: 'null'
          description: The ID of the worker job.
          title: jobId
        name:
          description: Name of the search study.
          title: name
          type: string
        numConcurrentTrials:
          description: The number of simultaneously running trials.
          title: numConcurrentTrials
          type: integer
        numTrials:
          description: The number of search trials to sample.
          title: numTrials
          type: integer
        optimizationObjectives:
          description: Optimization objectives of a study.
          items:
            maxItems: 2
            minItems: 2
            prefixItems:
            - $ref: '#/components/schemas/SearchObjective'
            - $ref: '#/components/schemas/SearchDirection'
            type: array
          title: optimizationObjectives
          type: array
        paretoFront:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          description: Pareto frontier of a study.
          title: paretoFront
        playgroundId:
          description: The ID of the existing playground that will be associated with
            the search.
          title: playgroundId
          type: string
        searchSpace:
          anyOf:
          - $ref: '#/components/schemas/SearchSpace'
          - type: 'null'
          description: Search space for the search.
        searchStudyId:
          description: The ID of the search study.
          title: searchStudyId
          type: string
        studyStatus:
          $ref: '#/components/schemas/JobStatus'
          description: Status of a study (RUNNING, COMPLETED or FAILED).
        tempPlaygroundId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the temp playground.
          title: tempPlaygroundId
        trialsFailed:
          anyOf:
          - type: integer
          - type: 'null'
          description: The number of failed trials.
          title: trialsFailed
        trialsRunning:
          anyOf:
          - type: integer
          - type: 'null'
          description: The number of currently running trials.
          title: trialsRunning
        trialsSuccess:
          anyOf:
          - type: integer
          - type: 'null'
          description: The number of completed trials.
          title: trialsSuccess
        useCaseId:
          description: The ID of the use case the search study is linked to.
          title: useCaseId
          type: string
        userId:
          description: The ID of the user.
          title: userId
          type: string
        userName:
          description: The user name of the user who ran the study.
          title: userName
          type: string
      required:
      - searchSpace
      - useCaseId
      - groundingDatasetId
      - evalDatasetId
      - groundingDatasetName
      - evalDatasetName
      - userId
      - userName
      - numTrials
      - numConcurrentTrials
      - optimizationObjectives
      - playgroundId
      - tempPlaygroundId
      - paretoFront
      - datetimeStart
      - datetimeEnd
      - studyStatus
      - searchStudyId
      - name
      - jobId
      - trialsRunning
      - trialsFailed
      - trialsSuccess
      - allTrials
      - existingBlueprintIds
      - evalResults
      - errorMessage
      title: SearchStudyResponse
      type: object
    SeatLicense:
      description: The seat license
      properties:
        createdAt:
          description: The creation date of the seat license.
          format: date-time
          type: string
        currentAllocation:
          description: The total number of seat license allocations; null if the limit
            is null (i.e., unlimited).
          type:
          - integer
          - 'null'
        description:
          description: The description of the seat license.
          type: string
        id:
          description: The ID of the seat license.
          maxLength: 36
          minLength: 32
          type: string
        limit:
          description: The total limit seat licenses available in the cluster, null
            if unlimited
          type:
          - integer
          - 'null'
        name:
          description: The name of the seat license.
          type: string
      required:
      - createdAt
      - currentAllocation
      - description
      - id
      - limit
      - name
      type: object
      x-versionadded: v2.36
    SeatLicenseAllocation:
      description: The seat license allocation
      properties:
        createdAt:
          description: The creation date of the seat license allocation.
          format: date-time
          type: string
        currentAllocation:
          description: The current number of seat license grants within the organization,
            corresponding to the number of subjects.
          type:
          - integer
          - 'null'
        id:
          description: The ID of the seat license allocation.
          maxLength: 36
          minLength: 32
          type: string
        limit:
          description: The total limit of seat license grants available for the organization.
          type: integer
        orgId:
          description: The ID of the organization the seat license has been allocated
            to.
          type: string
        seatLicense:
          $ref: '#/components/schemas/SeatLicense'
        subjects:
          description: The subjects that have been granted the seat license
          items:
            $ref: '#/components/schemas/Subject'
          maxItems: 1000
          type: array
        updatedAt:
          description: The date when the seat license allocation was last updated.
          format: date-time
          type: string
      required:
      - createdAt
      - currentAllocation
      - id
      - limit
      - orgId
      - seatLicense
      - subjects
      - updatedAt
      type: object
      x-versionadded: v2.36
    SeatLicenseAllocationCreate:
      properties:
        limit:
          description: The total number of seat license grants available for the organization.
          exclusiveMinimum: 0
          type: integer
        orgId:
          description: The ID of the organization to allocate the seat license to.
          type: string
        seatLicenseId:
          description: The ID of the seat license.
          maxLength: 36
          minLength: 32
          type: string
        subjects:
          description: The subjects to grant the seat license to.
          items:
            $ref: '#/components/schemas/SubjectCreate'
          maxItems: 1000
          type: array
      required:
      - limit
      - orgId
      - seatLicenseId
      type: object
      x-versionadded: v2.36
    SeatLicenseAllocationUpdate:
      properties:
        addSubjects:
          description: The subjects to grant the seat license to.
          items:
            $ref: '#/components/schemas/SubjectCreate'
          maxItems: 100
          type: array
        limit:
          description: The total number of seat license grants available for the organization.
          exclusiveMinimum: 0
          type: integer
        removeSubjects:
          description: The subjects to remove the seat license from.
          items:
            $ref: '#/components/schemas/SubjectCreate'
          maxItems: 100
          type: array
      type: object
      x-versionadded: v2.36
    SeatLicenseAllocationsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The queried seat license allocations.
          items:
            $ref: '#/components/schemas/SeatLicenseAllocation'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    SeatLicenseEvaluateRequest:
      properties:
        orgId:
          description: The ID of the organization the seat license was allocated to.
            Must correspond to the subject's organization.
          type: string
        seatName:
          description: The name of the seat license.
          type: string
        subjectId:
          description: The ID of the subject.
          type: string
        subjectType:
          description: The type of the subject
          enum:
          - user
          type: string
      required:
      - orgId
      - seatName
      - subjectId
      - subjectType
      type: object
      x-versionadded: v2.36
    SeatLicenseEvaluateResponse:
      properties:
        allowed:
          description: 'The result of the evaluation: true if the subject is allowed
            to use the seat license, false otherwise.'
          type: boolean
        seatLicenseAllocation:
          $ref: '#/components/schemas/SeatLicenseAllocation'
      required:
      - allowed
      - seatLicenseAllocation
      type: object
      x-versionadded: v2.36
    SeatLicensesListResponse:
      properties:
        data:
          description: The queried seat licenses.
          items:
            $ref: '#/components/schemas/SeatLicense'
          maxItems: 100
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.36
    SeccompProfile:
      additionalProperties: false
      description: Seccomp profile configuration.
      properties:
        localhostProfile:
          anyOf:
          - type: string
          - type: 'null'
          description: Path to a seccomp profile on the node. Only valid when type
            is Localhost.
          title: Localhostprofile
        type:
          $ref: '#/components/schemas/SeccompProfileType'
          description: Seccomp profile type
      required:
      - type
      title: SeccompProfile
      type: object
    SeccompProfileType:
      description: Allowed seccomp profile types.
      enum:
      - RuntimeDefault
      - Unconfined
      - Localhost
      title: SeccompProfileType
      type: string
    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: The number of items returned on this page.
          type: integer
        data:
          description: Secondary dataset configurations.
          items:
            $ref: '#/components/schemas/ProjectSecondaryDatasetConfigResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    SecondaryDatasetConfigResponse:
      properties:
        created:
          description: DR-formatted datetime, null for legacy (before DR 6.0) db records.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        creatorFullName:
          description: Full name or email of the user who created this config. Null
            for legacy (before DR 6.0) db records.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        creatorUserId:
          description: ID of the user who created this config, null for legacy (before
            DR 6.0) db records.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        credentialIds:
          description: The list of credentials used by the secondary datasets if the
            datasets used in the configuration are from a datasource.
          items:
            $ref: '#/components/schemas/DatasetsCredential'
          type: array
        featurelistId:
          description: ID of the feature list.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        isDefault:
          description: Whether the secondary datasets config is the default config.
          type: boolean
        isDeleted:
          description: Whether the secondary datasets config is soft-deleted.
          type: boolean
        name:
          description: Name of the secondary datasets config.
          type:
          - string
          - 'null'
        projectId:
          description: ID of the project.
          type:
          - string
          - 'null'
        secondaryDatasetConfigId:
          description: ID of the secondary datasets configuration.
          type: string
        secondaryDatasets:
          description: The 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: The 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.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      required:
      - catalogId
      - catalogVersionId
      - identifier
      - snapshotPolicy
      type: object
    SecondaryDatasetsConfig:
      properties:
        configId:
          description: ID of the secondary datasets configuration.
          type: string
        configName:
          description: The name of the secondary datasets config.
          type: string
        updated:
          description: Timestamp when configuration was updated on the given deployment.
          type: string
        username:
          description: The 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - count
      - data
      - next
      - previous
      type: object
    SectionCustom:
      properties:
        description:
          description: Section description
          type:
          - string
          - 'null'
        highlightedText:
          description: Highlighted text of the section, optionally separated by ``\n``
            to split paragraphs.
          maxLength: 5000
          type: string
        instructions:
          $ref: '#/components/schemas/InstructionsField'
        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'
          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
          - LLM_SYSTEM_STAKEHOLDERS
          - LLM_DEVELOPMENT_PURPOSE_AND_INTENDED_USE
          - GEN_AI_LLM_SYSTEM_DESCRIPTION_AND_OVERVIEW
          - LLM_DATA_OVERVIEW
          - LLM_RAG_DATA
          - LLM_FINE_TUNING_DATA
          - LLM_OVERVIEW
          - LLM_MODEL_CARD
          - LLM_RISKS_AND_LIMITATIONS
          - LLM_INTERDEPENDENCIES
          - LLM_LITERATURE_REFERENCES
          - LLM_EVALUATION
          - LLM_COPYRIGHT_CONCERNS
          - LLM_REGISTRY_GOVERNANCE
          - LLM_REGISTRY_VERSION_CONTROL
          type: string
        description:
          description: Section description
          type:
          - string
          - 'null'
        instructions:
          $ref: '#/components/schemas/InstructionsField'
        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'
          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
          type:
          - string
          - 'null'
        highlightedText:
          description: Highlighted text of the section, optionally separated by ``\n``
            to split paragraphs.
          maxLength: 5000
          type: string
        instructions:
          $ref: '#/components/schemas/InstructionsField'
        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'
          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
    SecureConfigCreate:
      properties:
        name:
          description: The name of the secure configuration.
          type: string
        schemaName:
          description: The name of the schema used for validating the secure configuration.
          type: string
        values:
          description: The values to associate with the secure configuration.
          items:
            $ref: '#/components/schemas/SecureConfigKeyValue'
          maxItems: 100
          type: array
      required:
      - name
      - schemaName
      - values
      type: object
      x-versionadded: v2.36
    SecureConfigGrantAccessControlWithIdWithGrantValidators:
      properties:
        canShare:
          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, EDITOR,
            CONSUMER.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.36
    SecureConfigGrantAccessControlWithUsernameWithGrantValidators:
      properties:
        canShare:
          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, EDITOR,
            CONSUMER.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: Describes the recipient type, either user, group, or organization.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
        username:
          description: Username of the user to update the access role for.
          type: string
      required:
      - role
      - shareRecipientType
      - username
      type: object
      x-versionadded: v2.36
    SecureConfigKeyValue:
      properties:
        key:
          description: The name of the key for the secure configuration value.
          type: string
        value:
          description: The value of the secure configuration.
          type: string
      required:
      - key
      - value
      type: object
      x-versionadded: v2.36
    SecureConfigListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of secure configurations.
          items:
            $ref: '#/components/schemas/SecureConfigResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    SecureConfigListValuesResponse:
      properties:
        secureConfigId:
          description: The ID of the SecureConfig.
          maxLength: 36
          minLength: 32
          type: string
        values:
          description: The secure configuration values.
          items:
            $ref: '#/components/schemas/SecureConfigKeyValue'
          type: array
      required:
      - secureConfigId
      - values
      type: object
      x-versionadded: v2.36
    SecureConfigResponse:
      properties:
        createdAt:
          description: When this secure configuration was created.
          format: date-time
          type: string
        id:
          description: The ID of the secure configuration.
          maxLength: 36
          minLength: 32
          type: string
        name:
          description: The name of the secure configuration.
          type: string
        ownerId:
          description: The ID of the secure configuration owner.
          type: string
        schemaName:
          description: The name of the schema used for the secure configuration.
          type: string
        valuesHref:
          description: Relative URI that points to the values for this secure configuration.
          type: string
      required:
      - createdAt
      - id
      - name
      - ownerId
      - schemaName
      - valuesHref
      type: object
      x-versionadded: v2.36
    SecureConfigSchema:
      description: Secure config schema definition.
      properties:
        $id:
          description: Secure config schema identifier.
          format: uri
          type: string
        $schema:
          default: http://json-schema.org/draft-07/schema#
          description: The JSON schema meta schema version.
          enum:
          - http://json-schema.org/draft-07/schema#
          type: string
        additionalProperties:
          default: false
          description: Allows properties other than schema defined in corresponding
            secure configs.
          type: boolean
        description:
          description: Secure config schema description.
          type: string
        properties:
          additionalProperties:
            $ref: '#/components/schemas/SecureConfigSchemaProperty'
          description: Secure config properties' definitions.
          type: object
        required:
          description: The list of required properties.
          items:
            type: string
          type: array
        title:
          description: Secure config schema title.
          type: string
        type:
          default: object
          description: Secure config definition type.
          enum:
          - object
          type: string
      required:
      - $id
      - $schema
      - additionalProperties
      - description
      - properties
      - required
      - title
      type: object
      x-versionadded: v2.36
    SecureConfigSchemaListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of secure configuration schemas.
          items:
            $ref: '#/components/schemas/SecureConfigSchemaResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    SecureConfigSchemaProperty:
      properties:
        description:
          description: Property description.
          type: string
        format:
          description: Property value format.
          enum:
          - uri
          type: string
        title:
          description: Property title.
          type: string
        type:
          description: Property type.
          enum:
          - string
          - array
          type: string
      required:
      - description
      - title
      - type
      type: object
      x-versionadded: v2.36
    SecureConfigSchemaResponse:
      properties:
        id:
          description: The ID of the secure configuration.
          maxLength: 36
          minLength: 32
          type: string
        name:
          description: The name of the secure configuration.
          type: string
        schemaDefinition:
          $ref: '#/components/schemas/SecureConfigSchema'
      required:
      - id
      - name
      - schemaDefinition
      type: object
      x-versionadded: v2.36
    SecureConfigSharedRolesEntry:
      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
          - EDITOR
          - CONSUMER
          type: string
        shareRecipientType:
          description: The recipient type.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.36
    SecureConfigSharedRolesList:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: Details about the Shared Role entries.
          items:
            $ref: '#/components/schemas/SecureConfigSharedRolesEntry'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.36
    SecureConfigSharingUpdate:
      properties:
        roles:
          description: An array of RoleRequest objects. May contain at most 100 such
            objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/SecureConfigGrantAccessControlWithUsernameWithGrantValidators'
            - $ref: '#/components/schemas/SecureConfigGrantAccessControlWithIdWithGrantValidators'
          maxItems: 100
          minItems: 1
          type: array
      required:
      - roles
      type: object
      x-versionadded: v2.36
    SecureConfigUpdate:
      properties:
        name:
          description: The name of the secure configuration.
          type: string
        schemaName:
          description: The name of the schema used for validating the secure configuration.
          type:
          - string
          - 'null'
        values:
          description: The values to associate with the secure configuration.
          items:
            $ref: '#/components/schemas/SecureConfigKeyValue'
          maxItems: 100
          type: array
      type: object
      x-versionadded: v2.36
    SecurityContext:
      additionalProperties: false
      description: "Container-level security context.\n\nLets workload creators tighten\
        \ security constraints beyond the platform defaults. runAsNonRoot and runAsUser\
        \ are enforced by the platform and are not user-settable. Elevated fields\
        \ (capabilities.add, allowPrivilegeEscalation=true, seccompProfile.type=Unconfined)\
        \ require the MLOps Admin role; regular users may only tighten defaults \u2014\
        \ drop capabilities, enable read-only rootfs, or set a RuntimeDefault/Localhost\
        \ seccomp profile."
      properties:
        allowPrivilegeEscalation:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether a process can gain more privileges than its parent.
            Requires the MLOps Admin role to set to True.
          title: Allowprivilegeescalation
        capabilities:
          anyOf:
          - $ref: '#/components/schemas/Capabilities'
          - type: 'null'
          description: Linux capabilities to add or drop
        readOnlyRootFilesystem:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the root filesystem is read-only
          title: Readonlyrootfilesystem
        seccompProfile:
          anyOf:
          - $ref: '#/components/schemas/SeccompProfile'
          - type: 'null'
          description: Seccomp profile for the container
      title: SecurityContext
      type: object
    SegmentAnalysis:
      description: The segment analysis setting for the deployment.
      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
    SegmentAttributesRetrieveResponse:
      properties:
        data:
          description: The segment attributes that were retrieved.
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        monitoringType:
          description: The monitoring type for which segment attributes are being
            retrieved.
          enum:
          - serviceHealth
          - dataDrift
          - accuracy
          - humility
          - customMetrics
          - geospatial
          type: string
      required:
      - data
      - monitoringType
      type: object
      x-versionadded: v2.35
    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: The ID of the segment champion model.
          type:
          - string
          - 'null'
        projectId:
          description: The ID of the project used for this segment.
          type:
          - string
          - 'null'
        segment:
          description: Segment name.
          type: string
      required:
      - modelId
      - projectId
      - segment
      type: object
    SegmentValue:
      properties:
        segmentAttribute:
          description: Name of the segment attribute.
          type: string
        value:
          description: The segment value.
          type: string
          x-versionadded: v2.35
      required:
      - segmentAttribute
      - value
      type: object
      x-versionadded: v2.35
    SegmentValuesRetrieveResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of segment values.
          items:
            $ref: '#/components/schemas/SegmentValue'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    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: The latest date in the segment.
          format: date-time
          type: string
        minDate:
          description: The earliest date in the segment.
          format: date-time
          type: string
        name:
          description: The name of the segment.
          type: string
        numberOfRows:
          description: The number of rows in the segment.
          exclusiveMinimum: 0
          type: integer
        sizeInBytes:
          description: The size of the segment in bytes.
          exclusiveMinimum: 0
          type: integer
      required:
      - maxDate
      - minDate
      - name
      - numberOfRows
      - sizeInBytes
      type: object
    SegmentationResultsCompletedResponse:
      properties:
        name:
          description: The name of the segmentation task job.
          type: string
        segmentationTaskId:
          description: The ID of the completed segmentation task.
          type: string
        segmentsCount:
          description: The number of segments produced by the task.
          type: integer
        segmentsEda:
          description: The array of segments EDA information.
          items:
            $ref: '#/components/schemas/SegmentationEDACompletedResponse'
          type: array
        url:
          description: The URL to retrieve detailed information about the segmentation
            task.
          type: string
      required:
      - name
      - segmentationTaskId
      - segmentsCount
      - segmentsEda
      - url
      type: object
    SegmentationResultsFailedResponse:
      properties:
        message:
          description: The 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'
      required:
      - message
      - name
      - parameters
      type: object
    SegmentationResultsResponse:
      properties:
        completedJobs:
          description: The list of completed segmentation tasks.
          items:
            $ref: '#/components/schemas/SegmentationResultsCompletedResponse'
          type: array
        failedJobs:
          description: The list of failed segmentation tasks.
          items:
            $ref: '#/components/schemas/SegmentationResultsFailedResponse'
          type: array
        numberOfJobs:
          description: The 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: The model package ID for using an external model registry package.
          type: string
        multiseriesIdColumns:
          description: The 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: The 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:
      description: The data for the segmentation task.
      properties:
        clusteringModelId:
          description: The ID of the model used by the segmentation task for automated
            segmentation.
          type:
          - string
          - 'null'
        clusteringModelName:
          description: The name of the model used by the segmentation task for automated
            segmentation.
          type:
          - string
          - 'null'
        clusteringProjectId:
          description: The ID of the project used by the segmentation task for automated
            segmentation.
          type:
          - string
          - 'null'
        datetimePartitionColumn:
          description: The name of the datetime partitioning column used by the segmentation
            task.
          type: string
        modelPackageId:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of the segmentation tasks that are associated with
            the project ID.
          items:
            $ref: '#/components/schemas/SegmentationTaskResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    SegmentationTaskMetadataResponse:
      description: The metadata for the segmentation task.
      properties:
        useAutomatedSegmentation:
          description: Whether the segmentation task uses automated segmentation.
          type: boolean
        useMultiseriesIdColumns:
          description: Whether the segmentation task uses a multiseries column.
          type: boolean
        useTimeSeries:
          description: Whether the segmentation task is a time series task.
          type: boolean
      required:
      - useAutomatedSegmentation
      - useMultiseriesIdColumns
      - useTimeSeries
      type: object
    SegmentationTaskResponse:
      properties:
        created:
          description: The date and time when the segmentation task was originally
            created.
          format: date-time
          type: string
        data:
          $ref: '#/components/schemas/SegmentationTaskDataResponse'
        metadata:
          $ref: '#/components/schemas/SegmentationTaskMetadataResponse'
        name:
          description: The name of the segmentation task.
          type: string
        projectId:
          description: The ID of the parent project associated with the segmentation
            task.
          type: string
        segmentationTaskId:
          description: Id of the segmentation task
          type: string
        segments:
          description: The names of the unique segments generated by the segmentation
            task.
          items:
            type: string
          type: array
        segmentsCount:
          description: The number of segments generated by the segmentation task.
          type: integer
        segmentsEda:
          description: The array of segments EDA information.
          items:
            $ref: '#/components/schemas/SegmentationEDACompletedResponse'
          type: array
        type:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The array of segmentation mappings.
          items:
            $ref: '#/components/schemas/SegmentationDataMappingResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    Select:
      description: Indicates that the value can be one selected from a list of known
        values.
      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.
          type:
          - number
          - 'null'
        cluster:
          description: 'The cluster associated with this series. '
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        holdoutScore:
          description: The holdout set score for this series. If holdout is locked
            for the project, this score will be null.
          type:
          - number
          - 'null'
        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
          type:
          - string
          - 'null'
        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.
          oneOf:
          - type: string
          - type: number
          - type: 'null'
        validationScore:
          description: The validation set score for this series
          type:
          - number
          - 'null'
      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).
          type:
          - string
          - 'null'
        previous:
          description: A URL pointing to the previous page (if null, there is no previous
            page).
          type:
          - string
          - 'null'
        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:
      description: Configure Server-Side Encryption for S3 output
      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
    ServiceArtifactSpec:
      additionalProperties: false
      properties:
        containerGroups:
          default: []
          description: List of container groups.
          items:
            $ref: '#/components/schemas/ContainerGroup'
          title: Containergroups
          type: array
        type:
          const: service
          default: service
          description: "Artifact type discriminator. Injected automatically from the\
            \ top-level `type` field \u2014 do not set this directly."
          title: Type
          type: string
      title: ServiceArtifactSpec
      type: object
    ServiceHealth:
      description: Service health status setting.
      properties:
        batchCount:
          description: Number of recent batches used to compute the service health
            status. Only applicable to deployments with batch monitoring enabled.
          enum:
          - 1
          - 5
          - 10
          - 50
          - 100
          - 1000
          - 10000
          type: integer
          x-versionadded: v2.33
        failingConditions:
          description: Conditions for "failing" status.
          items:
            $ref: '#/components/schemas/ServiceHealthMetricCondition'
          maxItems: 25
          type: array
          x-versionadded: v2.41
        timeInterval:
          description: Amount of time used to compute service health status. Only
            applicable to deployments with batch monitoring disabled.
          enum:
          - T1H
          - T2H
          - P1D
          - P7D
          - P30D
          - P90D
          - P180D
          - P365D
          type: string
          x-versionadded: v2.41
        warningConditions:
          description: Conditions for "warning" status.
          items:
            $ref: '#/components/schemas/ServiceHealthMetricCondition'
          maxItems: 25
          type: array
          x-versionadded: v2.41
      type: object
    ServiceHealthMetricCondition:
      properties:
        compareOperator:
          description: Defines how the metric value is compared against the threshold.
          enum:
          - lt
          - lte
          - gt
          - gte
          type: string
        metric:
          description: Service health metric to evaluate.
          enum:
          - dataErrorCount
          - serverErrorCount
          - dataErrorPercent
          - serverErrorPercent
          - medianResponseTimeMs
          - medianExecutionTimeMs
          type: string
        threshold:
          description: Threshold value used to determine if the condition is met.
          type: number
      required:
      - compareOperator
      - metric
      - threshold
      type: object
      x-versionadded: v2.41
    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'
          x-versionadded: v2.33
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
      required:
      - batches
      - metrics
      type: object
    ServiceStatsForTimeRangeResponse:
      properties:
        metrics:
          $ref: '#/components/schemas/ServiceStatsMetricsForTimeRange'
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
        period:
          $ref: '#/components/schemas/TimeRange'
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
      required:
      - metrics
      - period
      type: object
    ServiceStatsMetricsForBatch:
      description: Service health metrics of the deployment
      properties:
        cacheHitRatio:
          description: Number of cache hits.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        executionTime:
          description: Request execution time at executionTimeQuantile (in milliseconds).
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        numConsumers:
          description: Number of unique users performing requests.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        responseTime:
          description: Request response time at responseTimeQuantile (in milliseconds).
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        serverErrorRate:
          description: Ratio of server errors to the total number of requests.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
        slowRequests:
          description: Number of requests with response time greater than slowRequestsThreshold
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        totalPredictions:
          description: Total number of prediction rows.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        totalRequests:
          description: Total number of prediction requests performed.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        userErrorRate:
          description: Ratio of user errors to the total number of requests.
          type:
          - number
          - 'null'
          x-versionadded: v2.33
      required:
      - cacheHitRatio
      - executionTime
      - numConsumers
      - responseTime
      - serverErrorRate
      - slowRequests
      - totalPredictions
      - totalRequests
      - userErrorRate
      type: object
    ServiceStatsMetricsForTimeRange:
      description: Service health metrics of the deployment
      properties:
        cacheHitRatio:
          description: Number of cache hits.
          type:
          - number
          - 'null'
        executionTime:
          description: Request execution time at executionTimeQuantile (in milliseconds).
          type:
          - number
          - 'null'
        medianLoad:
          description: Median of the request rate (in requests per minute).
          type:
          - number
          - 'null'
        numConsumers:
          description: Number of unique users performing requests.
          type:
          - integer
          - 'null'
        peakLoad:
          description: Maximum of the request rate (in requests per minute).
          type:
          - number
          - 'null'
        responseTime:
          description: Request response time at responseTimeQuantile (in milliseconds).
          type:
          - number
          - 'null'
        serverErrorRate:
          description: Ratio of server errors to the total number of requests.
          type:
          - number
          - 'null'
        slowRequests:
          description: Number of requests with response time greater than slowRequestsThreshold
          type:
          - integer
          - 'null'
        totalPredictions:
          description: Total number of prediction rows.
          type:
          - integer
          - 'null'
        totalRequests:
          description: Total number of prediction requests performed.
          type:
          - integer
          - 'null'
        userErrorRate:
          description: Ratio of user errors to the total number of requests.
          type:
          - number
          - 'null'
      required:
      - cacheHitRatio
      - executionTime
      - medianLoad
      - numConsumers
      - peakLoad
      - responseTime
      - serverErrorRate
      - slowRequests
      - totalPredictions
      - totalRequests
      - userErrorRate
      type: object
    ServiceStatsOverBatchBucket:
      description: Service health stats of the deployment over a batch.
      properties:
        batch:
          $ref: '#/components/schemas/Batch'
          x-versionadded: v2.33
        value:
          description: Value of the metric in the bucket.
          type:
          - number
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
      required:
      - buckets
      - metric
      type: object
    ServiceStatsOverTimeBucket:
      description: Service health stats of the deployment over a time range.
      properties:
        modelId:
          description: The id of the model for which metrics are being retrieved.
          type: string
          x-versionadded: v2.37
        period:
          $ref: '#/components/schemas/TimeRange'
        value:
          description: Value of the metric in the bucket. Null if no value
          type:
          - number
          - 'null'
      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.
            Deprecated, use modelId in each bucket instead.
          type: string
          x-versiondeprecated: v2.37
        segmentAttribute:
          description: The name of the segment on which segment analysis is being
            performed.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          x-versionadded: v2.20
        summary:
          $ref: '#/components/schemas/ServiceStatsOverTimeBucket'
          x-versiondeprecated: v2.37
      required:
      - buckets
      - metric
      type: object
    SessionDeduplicationErrorResponse:
      description: 'Body returned with HTTP 409 when a session create collides on
        `deduplicationKey`.


        Carries enough context for an HA-replica caller to adopt the existing winner

        without a second round-trip: the live session''s id and a path to it.'
      properties:
        deduplicationKey:
          description: The deduplication key that triggered the conflict.
          title: Deduplicationkey
          type: string
        detail:
          description: Human-readable explanation of the conflict.
          title: Detail
          type: string
        errorName:
          const: SessionDeduplicationConflict
          default: SessionDeduplicationConflict
          description: Stable machine-readable error name. Clients should switch on
            this, not detail.
          title: Errorname
          type: string
        existingSessionId:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: ID of the live session already holding the key, or null if
            it could not be resolved (e.g. concurrently soft-deleted).
          title: Existingsessionid
        existingSessionUrl:
          anyOf:
          - type: string
          - type: 'null'
          description: Path to GET the existing session. Null when `existingSessionId`
            is null. Mirrors the `Location` response header (which is absolute).
          title: Existingsessionurl
      required:
      - detail
      - deduplicationKey
      title: SessionDeduplicationErrorResponse
      type: object
    SessionResponse:
      description: Schema for session response.
      properties:
        createdAt:
          description: Session creation timestamp.
          format: date-time
          title: Createdat
          type: string
        deduplicationKey:
          anyOf:
          - type: string
          - type: 'null'
          description: Deduplication key, unique within the memory space, if one was
            set.
          title: Deduplicationkey
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Session description.
          title: Description
        id:
          description: Session ID.
          format: uuid
          title: Id
          type: string
        lifecycleStrategies:
          description: Lifecycle strategies associated with this session.
          items:
            $ref: '#/components/schemas/LifecycleStrategyResponse'
          maxItems: 5
          title: Lifecyclestrategies
          type: array
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Custom metadata as key-value pairs for storing application-specific
            data
          title: Metadata
        participants:
          description: List of participant IDs.
          items:
            type: string
          maxItems: 1
          title: Participants
          type: array
        version:
          default: 1
          description: 'Monotonic version for optimistic concurrency. Echo back as
            `If-Match: "<version>"` on PATCH to detect lost updates.'
          minimum: 1.0
          title: Version
          type: integer
      required:
      - id
      - participants
      - createdAt
      title: SessionResponse
      type: object
    SessionType:
      description: 'Session type is either ''interactive'', meaning a user has started
        the session via their own interactions or

        ''triggered'' for when a session is started programmatically.'
      enum:
      - interactive
      - triggered
      title: SessionType
      type: string
    SetCredentialsAssociationRequest:
      properties:
        isDefault:
          default: false
          description: Whether this credentials' association with the given object
            is default for given session user.
          type: boolean
      type: object
    SettingFormat:
      description: Supported formats for settings.
      enum:
      - multiline
      title: SettingFormat
      type: string
    SettingType:
      description: Supported data types for settings.
      enum:
      - integer
      - float
      - string
      - boolean
      - object_id
      - list
      title: SettingType
      type: string
    ShapDistributionsData:
      description: SHAP distributions data.
      properties:
        features:
          description: List of SHAP distributions for each requested row.
          items:
            $ref: '#/components/schemas/ShapDistributionsRow'
          maxItems: 100
          type: array
        totalFeaturesCount:
          description: The total number of features.
          type: integer
      required:
      - features
      - totalFeaturesCount
      type: object
      x-versionadded: v2.35
    ShapDistributionsRow:
      properties:
        feature:
          description: The feature name in the dataset.
          type: string
        featureType:
          description: The feature type.
          enum:
          - T
          - X
          - B
          - C
          - CI
          - N
          - D
          - DD
          - FD
          - Q
          - CD
          - GEO
          - MC
          - INT
          - DOC
          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
        shapValues:
          description: The SHAP distributions values for this row.
          items:
            $ref: '#/components/schemas/ShapDistributionsValue'
          maxItems: 2500
          type: array
      required:
      - feature
      - featureType
      - impactNormalized
      - impactUnnormalized
      - shapValues
      type: object
      x-versionadded: v2.35
    ShapDistributionsValue:
      properties:
        featureRank:
          description: The SHAP value rank of the feature for this row.
          exclusiveMinimum: 0
          type: integer
        featureValue:
          anyOf:
          - type: integer
          - type: number
          - type: string
          - type: 'null'
          description: The value of the feature for this row.
        predictionValue:
          description: The prediction value for this row.
          type: number
        rowIndex:
          description: The index of this row.
          minimum: 0
          type:
          - integer
          - 'null'
        shapValue:
          description: The SHAP value of the feature for this row.
          type: number
        weight:
          description: The weight of the row in the dataset.
          type:
          - number
          - 'null'
          x-versionadded: v2.37
      required:
      - featureRank
      - featureValue
      - predictionValue
      - rowIndex
      - shapValue
      - weight
      type: object
      x-versionadded: v2.35
    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:
      description: SHAP impact data.
      properties:
        baseValue:
          description: The mean of raw model predictions for the training data.
          items:
            type: number
          type: array
          x-versionadded: v2.33
        link:
          description: The link function used to connect the SHAP importance values
            to the model output.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        quickCompute:
          default: true
          description: When enabled, limits the rows used from the selected source
            subset by default. When disabled, all rows are used.
          type: boolean
          x-versionadded: v2.35
        rowCount:
          description: (Deprecated) The number of rows used to calculate SHAP impact.
            If ``rowCount`` is not specified, the value returned is ``null``.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
          x-versiondeprecated: v2.35
        shapImpacts:
          description: A list that contains SHAP impact scores.
          items:
            $ref: '#/components/schemas/ShapImpactEntity'
          type: array
          x-versionadded: v2.33
      required:
      - baseValue
      - link
      - rowCount
      - shapImpacts
      type: object
    ShapImpactEntity:
      properties:
        featureName:
          description: The feature name in the dataset.
          type: string
        impactNormalized:
          description: The normalized impact score value.
          type:
          - number
          - 'null'
        impactUnnormalized:
          description: The raw impact score value.
          type: number
      required:
      - featureName
      - impactNormalized
      - impactUnnormalized
      type: object
    ShapImpactRetrieveResponse:
      properties:
        count:
          description: The number of shapImpact objects 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 the 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:
      description: SHAP matrix data.
      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
          - 'null'
          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.
            Not used in time-aware projects.
          items:
            type: integer
          type: array
          x-versionadded: v2.33
        timeSeriesRowIndex:
          description: An index composed of the timestamp, series ID, and forecast
            distance. Only used in time-aware projects.
          items:
            items:
              oneOf:
              - type: integer
              - type: string
            maxLength: 2
            minLength: 2
            type: array
          type: array
          x-versionadded: v2.36
      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'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    ShapMatrixMetadataField:
      description: The metadata containing SHAP matrix calculation details.
      properties:
        maxNormalizedMismatch:
          default: 0
          description: The maximal relative normalized mismatch value.
          type: number
        mismatchRowCount:
          default: 0
          description: The count of rows for which additivity check failed.
          type: integer
      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:
      description: SHAP preview data.
      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
          - 'null'
          x-versionadded: v2.33
        timeSeriesRowIndex:
          description: An index composed of the timestamp, series ID, and forecast
            distance. This index is used only in time-aware projects.
          items:
            oneOf:
            - type: integer
            - type: string
          maxLength: 2
          minLength: 2
          type:
          - array
          - 'null'
          x-versionadded: v2.36
        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: 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
        isImage:
          description: Whether the feature is an image or not.
          type: boolean
          x-versionadded: v2.34
        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:
      description: A training prediction job
      properties:
        partitionName:
          description: The partition used for the prediction record.
          type: string
        value:
          $ref: '#/components/schemas/ShapWarningItems'
      required:
      - partitionName
      - value
      type: object
    ShapWarningItems:
      description: The warnings related to this partition
      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:
      description: Mismatch information.
      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:
      description: Will be present if `explanationAlgorithm` was set to `shap` and
        there were additivity failures during SHAP values calculation.
      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
    SharedRole:
      additionalProperties: false
      description: 'Represents a recipient (user, group, or organization) with access
        to an entity.


        This model is used for listing and managing access control on shared resources,

        providing information about who has access and what role they have.'
      properties:
        id:
          description: The identifier of the recipient.
          title: Id
          type: string
        name:
          description: The name of the recipient.
          title: Name
          type: string
        role:
          $ref: '#/components/schemas/SharingRole'
          description: The role of the recipient on this entity.
        shareRecipientType:
          $ref: '#/components/schemas/SubjectType'
          description: The type of the recipient.
      required:
      - id
      - name
      - shareRecipientType
      - role
      title: SharedRole
      type: object
    SharedRoleListResponse:
      additionalProperties: false
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/SharedRole'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: SharedRoleListResponse
      type: object
    SharedRolesBoundedListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of SharedRoles objects.
          items:
            $ref: '#/components/schemas/SharedRolesResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.45
    SharedRolesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of SharedRoles objects.
          items:
            $ref: '#/components/schemas/SharedRolesResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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 catalog entry or `NO_ROLE`
            for removing access when used with route to modify access.
          enum:
          - CONSUMER
          - EDITOR
          - OWNER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type.
          enum:
          - user
          - group
          - organization
          - externalApplication
          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
    SharedRolesUpdateRequest:
      additionalProperties: false
      description: 'Request model for updating shared roles on an entity.


        Used to grant access, remove access, or update roles for organizations,

        groups, or users. Up to 100 roles may be set in a single request.'
      properties:
        operation:
          const: updateRoles
          description: Name of the action being taken. The only operation is 'updateRoles'.
          title: Operation
          type: string
        roles:
          description: Array of GrantAccessControl objects, up to maximum 100 objects.
          items:
            anyOf:
            - $ref: '#/components/schemas/GrantAccessControlWithUsername'
            - $ref: '#/components/schemas/GrantAccessControlWithId'
          maxItems: 100
          minItems: 1
          title: Roles
          type: array
      required:
      - operation
      - roles
      title: SharedRolesUpdateRequest
      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: The URL pointing to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
        totalCount:
          description: The 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'
          maxItems: 1000
          type: array
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
      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'
          maxItems: 1000
          type: array
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items matching the condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    SharingRole:
      description: 'External sharing roles representing the permission level a user,
        group or

        organization holds on an entity.


        These roles map to internal permissions and are used in sharing APIs.'
      enum:
      - NO_ROLE
      - OWNER
      - READ_WRITE
      - EDITOR
      - USER
      - DATA_SCIENTIST
      - ADMIN
      - READ_ONLY
      - CONSUMER
      - OBSERVER
      title: SharingRole
      type: string
    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
    SidecarModelMetricMetadata:
      description: The metadata of a sidecar model metric.
      properties:
        expectedResponseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for expected response
            text input.
          title: expectedResponseColumnName
        promptColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for prompt text
            input.
          title: promptColumnName
        responseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for response text
            input.
          title: responseColumnName
        targetColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for prediction
            output.
          title: targetColumnName
      required:
      - targetColumnName
      title: SidecarModelMetricMetadata
      type: object
    SidecarModelMetricValidationResponse:
      description: API response object for a single sidecar model metric validation.
      properties:
        citationsPrefixColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The column name prefix the custom model uses for citation inputs.
          title: citationsPrefixColumnName
        creationDate:
          description: The creation date of the custom model validation (ISO 8601
            formatted).
          format: date-time
          title: creationDate
          type: string
        deploymentAccessData:
          anyOf:
          - $ref: '#/components/schemas/DeploymentAccessData'
          - type: 'null'
          description: The parameters used for accessing the deployment.
        deploymentId:
          description: The ID of the custom model deployment.
          title: deploymentId
          type: string
        deploymentName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the custom model deployment.
          title: deploymentName
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the validation error (if
            the validation failed).
          title: errorMessage
        errorResolution:
          anyOf:
          - items:
              $ref: '#/components/schemas/InsightErrorResolution'
            type: array
          - type: 'null'
          description: The error type associated with the insight error status and
            error message as an indicator of what fields needs to be edited if any.
          title: errorResolution
        expectedResponseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for expected response
            text input.
          title: expectedResponseColumnName
        id:
          description: The ID of the custom model validation.
          title: id
          type: string
        modelId:
          description: The ID of the model used in the deployment.
          title: modelId
          type: string
        moderationConfiguration:
          anyOf:
          - $ref: '#/components/schemas/ModerationConfigurationWithoutID'
          - type: 'null'
          description: The moderation configuration associated with the sidecar model
            metric.
        name:
          description: The name of the validated custom model.
          title: name
          type: string
        playgroundId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the playground associated with the sidecar model
            metric validation.
          title: playgroundId
        predictionTimeout:
          description: The timeout in seconds for the prediction API used in this
            custom model validation.
          title: predictionTimeout
          type: integer
        promptColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for prompt text
            input.
          title: promptColumnName
        responseColumnName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the column the custom model uses for response text
            input.
          title: responseColumnName
        targetColumnName:
          description: The name of the column the custom model uses for prediction
            output.
          title: targetColumnName
          type: string
        tenantId:
          description: The ID of the tenant the custom model validation belongs to.
          format: uuid4
          title: tenantId
          type: string
        useCaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the use case associated with the validated custom
            model.
          title: useCaseId
        userId:
          description: The ID of the user that created this custom model validation.
          title: userId
          type: string
        userName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the user that created this custom model validation.
          title: userName
        validationStatus:
          $ref: '#/components/schemas/CustomModelValidationStatus'
          description: The status of the custom model validation.
      required:
      - id
      - deploymentId
      - targetColumnName
      - validationStatus
      - modelId
      - deploymentAccessData
      - tenantId
      - name
      - useCaseId
      - creationDate
      - userId
      - predictionTimeout
      - playgroundId
      - citationsPrefixColumnName
      - promptColumnName
      - responseColumnName
      - expectedResponseColumnName
      title: SidecarModelMetricValidationResponse
      type: object
    SingleDeploymentSetting:
      properties:
        hint:
          description: An optional hint for the setting.
          maxLength: 255
          type:
          - string
          - 'null'
        label:
          description: A descriptive label for the setting.
          maxLength: 80
          type: string
        setting:
          description: The identifier of the setting.
          enum:
          - deploymentName
          - DeploymentName
          - DEPLOYMENT_NAME
          - settingsDataDrift
          - SettingsDataDrift
          - SETTINGS_DATA_DRIFT
          - settingsAccuracy
          - SettingsAccuracy
          - SETTINGS_ACCURACY
          - settingsFairness
          - SettingsFairness
          - SETTINGS_FAIRNESS
          - settingsCustomMetrics
          - SettingsCustomMetrics
          - SETTINGS_CUSTOM_METRICS
          - settingsHumility
          - SettingsHumility
          - SETTINGS_HUMILITY
          - settingsChallengers
          - SettingsChallengers
          - SETTINGS_CHALLENGERS
          - settingsPredictions
          - SettingsPredictions
          - SETTINGS_PREDICTIONS
          - settingsRetraining
          - SettingsRetraining
          - SETTINGS_RETRAINING
          - settingsUsage
          - SettingsUsage
          - SETTINGS_USAGE
          - settingsDataExploration
          - SettingsDataExploration
          - SETTINGS_DATA_EXPLORATION
          - settingsNotifications
          - SettingsNotifications
          - SETTINGS_NOTIFICATIONS
          type: string
        status:
          description: Indicates the completion status of the setting.
          enum:
          - notSet
          - NotSet
          - NOT_SET
          - partial
          - Partial
          - PARTIAL
          - configured
          - Configured
          - CONFIGURED
          type: string
      required:
      - hint
      - label
      - setting
      - status
      type: object
      x-versionadded: v2.38
    SmartDownsamplingArguments:
      description: The downsampling configuration.
      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
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - method
      - rows
      - skip
      type: object
    SnowflakeDataStreamer:
      description: Stream CSV data chunks from Snowflake
      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
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the cloud storage.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the Snowflake data source.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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:
      description: Stream CSV data chunks from Snowflake
      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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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
    SnowflakeKeyPairCredentialsFields:
      properties:
        configId:
          description: The ID of the saved shared credentials. If specified, cannot
            include user, privateKeyStr, or passphrase.
          type: string
          x-versionadded: v2.32
        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.
          minLength: 1
          type: string
          x-versionadded: v2.30
        privateKeyStr:
          description: Private key for key pair authentication. Required if configId
            is not specified. This cannot be included if configId is specified.
          minLength: 1
          type: string
          x-versionadded: v2.30
        user:
          description: Username for this credential. Required if configId is not specified.
            This cannot be included if configId is specified.
          type: string
      required:
      - credentialType
      type: object
      x-versionadded: v2.46
    SnowflakeOutput:
      description: Save CSV data chunks to Snowflake in bulk
      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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks to Snowflake in bulk
      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
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the cloud storage.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the Snowflake data source.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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.
          type:
          - number
          - 'null'
        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
    SortedPaginationQuerySchema:
      description: Schema for query parameters for paginated requests.
      properties:
        limit:
          default: 10
          description: The limit or results to return.
          exclusiveMinimum: 0.0
          maximum: 100.0
          title: Limit
          type: integer
        offset:
          default: 0
          description: The offset to use when querying paginated results.
          minimum: 0.0
          title: Offset
          type: integer
        sortBy:
          description: Field to sort by.
          title: Sortby
          type: string
      title: SortedPaginationQuerySchema
      type: object
    SourceDestinationSchema:
      description: Source and destination schema for filesystem object operations.
      properties:
        destination:
          description: Destination path.
          title: Destination
          type: string
        source:
          description: Source path.
          title: Source
          type: string
      required:
      - source
      - destination
      title: SourceDestinationSchema
      type: object
    SpanView:
      description: The span object.
      properties:
        attributes:
          additionalProperties:
            type: string
          description: The attributes of the span.
          type: object
        completion:
          description: The completion of the span.
          type:
          - string
          - 'null'
          x-versionadded: v2.45
        duration:
          description: The duration of the span.
          type: number
        entityInfo:
          $ref: '#/components/schemas/EntityInfo'
          x-versionadded: v2.45
        events:
          description: The list of events.
          items:
            $ref: '#/components/schemas/Event'
          maxItems: 1000
          type: array
        hasPermission:
          description: Whether the user has permission to view the span.
          type: boolean
        kind:
          description: The kind of the span.
          type: string
        links:
          description: The list of links.
          items:
            $ref: '#/components/schemas/LinkView'
          maxItems: 1000
          type: array
        name:
          description: The span name.
          type: string
        parentSpanId:
          description: The parent span ID.
          maxLength: 32
          minLength: 16
          type:
          - string
          - 'null'
        prompt:
          description: The prompt of the span.
          type:
          - string
          - 'null'
          x-versionadded: v2.45
        resource:
          $ref: '#/components/schemas/Resource'
        scope:
          additionalProperties:
            type: string
          description: The scope of the span.
          type: object
        serviceName:
          description: The service name of the span.
          type: string
        spanId:
          description: The span ID.
          maxLength: 32
          minLength: 16
          type: string
        startTime:
          description: The start time of the span
          type: number
        statusCode:
          description: The status code of the span.
          type:
          - string
          - 'null'
        statusMessage:
          description: The status message of the span.
          type:
          - string
          - 'null'
        traceId:
          description: The OTel trace ID.
          maxLength: 32
          minLength: 16
          type: string
        userInfo:
          $ref: '#/components/schemas/TracingUserInfo'
          x-versionadded: v2.45
      required:
      - attributes
      - duration
      - events
      - hasPermission
      - kind
      - links
      - name
      - resource
      - scope
      - serviceName
      - spanId
      - startTime
      - traceId
      type: object
      x-versionadded: v2.37
    SpoolerChannelEventData:
      description: Spooler channel event payload.
      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
    StandardUdfCreate:
      properties:
        credentialId:
          description: The ID of the set of credentials to use instead of username
            and password.
          type: string
        functionType:
          description: The standard user-defined function type.
          enum:
          - rolling_median
          - rolling_most_frequent
          type: string
        schema:
          description: The schema to create or detect user-defined functions in.
          type: string
      required:
      - functionType
      - schema
      type: object
      x-versionadded: v2.36
    StartKernelRequest:
      description: Request payload values for starting a kernel.
      properties:
        spec:
          description: Name of the kernel to start. Possible values include 'python3',
            'ir'.
          title: Spec
          type: string
      required:
      - spec
      title: StartKernelRequest
      type: object
    StartNotebookSessionSchema:
      description: Schema for starting a notebook session.
      properties:
        cloneRepository:
          allOf:
          - $ref: '#/components/schemas/CloneRepositorySchema'
          description: Automatically tells the runner to clone remote repository if
            it's supported as part of its environment setup flow.
          title: Clonerepository
        isTriggeredRun:
          default: false
          description: Indicates if the session is a triggered run versus an interactive
            run.
          title: Istriggeredrun
          type: boolean
        openFilePaths:
          description: List of file paths to open in the notebook session.
          items:
            type: string
          title: Openfilepaths
          type: array
        parameters:
          description: Parameters to use as environment variables.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
      title: StartNotebookSessionSchema
      type: object
    StartReplacementRequest:
      additionalProperties: false
      description: Request to start a replacement for a workload.
      properties:
        artifactId:
          description: Existing Artifact ID to deploy
          title: Artifactid
          type: string
        config:
          $ref: '#/components/schemas/ReplacementConfig'
          description: Configuration for the replacement process, including warmup
            duration and old version retention time
        runtime:
          anyOf:
          - $ref: '#/components/schemas/WorkloadRuntime'
          - type: 'null'
          description: Runtime for the workload; if omitted, the current runtime is
            reused
        strategy:
          $ref: '#/components/schemas/ReplacementStrategy'
          description: Replacement strategy
      required:
      - artifactId
      - strategy
      title: StartReplacementRequest
      type: object
    StatusIdResponse:
      properties:
        statusId:
          description: The ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the job's status.
          type: string
      required:
      - statusId
      type: object
      x-versionadded: v2.36
    StatusListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    StatusResponse:
      description: API response object for job execution status.
      properties:
        code:
          $ref: '#/components/schemas/JobErrorCode'
          description: The error code associated with the job.
        created:
          description: The creation date of the job (ISO 8601 formatted).
          format: date-time
          title: created
          type: string
        description:
          default: ''
          description: The description associated with the job.
          title: description
          type: string
        message:
          default: ''
          description: The error message associated with the job.
          title: message
          type: string
        status:
          $ref: '#/components/schemas/JobExecutionState'
          description: The execution status of the job.
        statusId:
          description: ID that can be used with :http:get:`/api/v2/status/(statusId)/`
            to poll for the testing job's status.
          format: uuid
          title: statusId
          type: string
        statusType:
          default: ''
          description: The type of the status object.
          title: statusType
          type: string
      required:
      - statusId
      title: StatusResponse
      type: object
      x-versionadded: v2.35
    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
          type:
          - string
          - 'null'
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        type:
          description: The type of thing being created by the Task, if applicable.
          enum:
          - CustomModelBlueprintBuild
          - CustomModelFeatureImpact
          - Testing
          - customModelWaitForServer
          - ManagedImageBuild
          - Dataset
          - LongRunningServiceControllerOperation
          - ProjectPermanentDeletion
          type:
          - string
          - 'null'
      required:
      - code
      - created
      - description
      - message
      - status
      - statusId
      type: object
    StopSession:
      properties:
        size:
          default: small
          description: The Spark instance size to stop.
          enum:
          - small
          - medium
          - large
          type: string
      type: object
      x-versionadded: v2.38
    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.
          type:
          - string
          - 'null'
      required:
      - credentialId
      type: object
    StreamOutputSchema:
      description: The schema for the stream output in a notebook cell.
      properties:
        name:
          description: Name of the stream.
          title: Name
          type: string
        outputType:
          const: stream
          default: stream
          description: Type of the output.
          title: Outputtype
          type: string
        text:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          description: Text of the stream.
          title: Text
      required:
      - name
      - text
      title: StreamOutputSchema
      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
    StringEnvironmentVariable:
      properties:
        name:
          description: Name of the environment variable
          title: Name
          type: string
        source:
          const: string
          default: string
          title: Source
          type: string
        value:
          description: Value of the environment variable
          title: Value
          type: string
      required:
      - name
      - value
      title: StringEnvironmentVariable
      type: object
    StringSettingConstraints:
      description: Available constraints for string settings.
      properties:
        allowedChoices:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The allowed values for the setting.
          title: allowedChoices
        maxLength:
          anyOf:
          - type: integer
          - type: 'null'
          description: The maximum length of the value (inclusive).
          title: maxLength
        minLength:
          anyOf:
          - type: integer
          - type: 'null'
          description: The minimum length of the value (inclusive).
          title: minLength
        type:
          const: string
          default: string
          description: The data type of the setting.
          title: type
          type: string
      title: StringSettingConstraints
      type: object
    Subject:
      description: The subject
      properties:
        createdAt:
          description: The date of the seat license allocation to the subject
          format: date-time
          type: string
        subjectId:
          description: The subject ID.
          type: string
        subjectType:
          description: The subject type.
          enum:
          - user
          type: string
      required:
      - createdAt
      - subjectId
      - subjectType
      type: object
      x-versionadded: v2.36
    SubjectCreate:
      description: The subject
      properties:
        subjectId:
          description: The subject ID.
          type: string
        subjectType:
          description: The subject type.
          enum:
          - user
          type: string
      required:
      - subjectId
      - subjectType
      type: object
      x-versionadded: v2.36
    SubjectType:
      description: Enum of possible subject types.
      enum:
      - user
      - group
      - organization
      - role
      title: SubjectType
      type: string
    SuccessResponse:
      description: Response schema indicating successful or failed operation.
      properties:
        success:
          description: Indicates whether the operation was successful.
          title: Success
          type: boolean
      required:
      - success
      title: SuccessResponse
      type: object
    SuccessfulInviteData:
      description: Details about the successful invite.
      properties:
        email:
          description: The email address of the invited user.
          type: string
        userId:
          description: The ID of the user.
          type: string
      required:
      - email
      - userId
      type: object
      x-versionadded: v2.39
    SuggestedReviewersResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    Summary:
      additionalProperties: false
      description: Summary information for proton statistics.
      properties:
        period:
          $ref: '#/components/schemas/Period'
          description: Time period for the summary
        protonId:
          description: Proton ID
          title: Protonid
          type: string
      required:
      - protonId
      - period
      title: Summary
      type: object
    SummaryPermadeleteStatus:
      description: Report id and associated status.
      properties:
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        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
    SupportedCellTypes:
      description: Supported cell types for notebooks.
      enum:
      - code
      - markdown
      title: SupportedCellTypes
      type: string
    SupportedCustomModelEmbeddings:
      description: API response object for a single custom embedding model.
      properties:
        id:
          description: The validation ID of the custom embedding model.
          title: id
          type: string
        name:
          description: The name of the custom embedding model.
          title: name
          type: string
      required:
      - id
      - name
      title: SupportedCustomModelEmbeddings
      type: object
    SupportedCustomModelLLMValidation:
      description: The metadata describing a validated custom model LLM.
      properties:
        id:
          description: The ID of the custom model LLM validation.
          title: id
          type: string
        name:
          description: The name of the custom model LLM validation.
          title: name
          type: string
      required:
      - id
      - name
      title: SupportedCustomModelLLMValidation
      type: object
    SupportedDeploymentType:
      description: The type of the target output a DataRobot deployment produces.
      enum:
      - TEXT_GENERATION
      - VECTOR_DATABASE
      - UNSTRUCTURED
      - REGRESSION
      - MULTICLASS
      - BINARY
      - NOT_SUPPORTED
      title: SupportedDeploymentType
      type: string
    SupportedEmbeddingsResponse:
      description: API response object for "List supported embeddings".
      properties:
        customModelEmbeddingValidations:
          description: The list of validated custom embedding models.
          items:
            $ref: '#/components/schemas/SupportedCustomModelEmbeddings'
          title: customModelEmbeddingValidations
          type: array
        defaultEmbeddingModel:
          description: The name of the default embedding model.
          title: defaultEmbeddingModel
          type: string
        embeddingModels:
          description: The list of embeddings models.
          items:
            $ref: '#/components/schemas/EmbeddingModel'
          title: embeddingModels
          type: array
        nimEmbeddingModels:
          description: The list of NIM registered models.
          items:
            $ref: '#/components/schemas/SupportedNIMModelEmbeddings'
          title: nimEmbeddingModels
          type: array
      required:
      - embeddingModels
      - defaultEmbeddingModel
      title: SupportedEmbeddingsResponse
      type: object
    SupportedInsightsResponse:
      description: Response model for supported insights.
      properties:
        insightsConfiguration:
          description: The list of supported insights configurations.
          items:
            $ref: '#/components/schemas/InsightsConfigurationWithAdditionalData'
          title: insightsConfiguration
          type: array
      required:
      - insightsConfiguration
      title: SupportedInsightsResponse
      type: object
    SupportedLanguagesResponse:
      description: API response object for "List supported languages for Synthetic
        Dataset generation".
      properties:
        recommendedLanguage:
          description: The recommended language.
          title: recommendedLanguage
          type: string
        supportedLanguages:
          description: The list of supported languages.
          items:
            type: string
          title: supportedLanguages
          type: array
      required:
      - recommendedLanguage
      - supportedLanguages
      title: SupportedLanguagesResponse
      type: object
    SupportedLlmListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of supported LLMs for moderation.
          items:
            $ref: '#/components/schemas/SupportedLlmResponse'
          maxItems: 200
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    SupportedLlmResponse:
      properties:
        description:
          description: The description of this LLM.
          maxLength: 1024
          type: string
        id:
          description: The ID for this LLM.
          maxLength: 1024
          type: string
        llmType:
          description: The general category of this LLM.
          maxLength: 1024
          type: string
        model:
          description: The specific model of this LLM.
          maxLength: 1024
          type: string
        name:
          description: The display name of this LLM.
          maxLength: 1024
          type: string
        provider:
          description: The provider of access to this LLM.
          maxLength: 1024
          type: string
        vendor:
          description: The vendor of this LLM.
          maxLength: 1024
          type: string
      required:
      - description
      - id
      - llmType
      - model
      - name
      - provider
      - vendor
      type: object
      x-versionadded: v2.35
    SupportedNIMModelEmbeddings:
      description: API response object for a single registered NIM embedding model.
      properties:
        description:
          description: The description of the registered NIM model.
          title: description
          type: string
        id:
          description: The validation ID of the registered NIM model.
          title: id
          type: string
        name:
          description: The name of the registered NIM model.
          title: name
          type: string
      required:
      - id
      - name
      - description
      title: SupportedNIMModelEmbeddings
      type: object
    SupportedRetrievalSettingsResponse:
      description: API response object for "Retrieve supported retrieval settings".
      properties:
        settings:
          description: The list of retrieval settings.
          items:
            $ref: '#/components/schemas/VectorDatabaseSettingParameter'
          title: settings
          type: array
      required:
      - settings
      title: SupportedRetrievalSettingsResponse
      type: object
    SupportedTextChunkingResponse:
      description: API response for "List text chunking methods".
      properties:
        textChunkingConfigs:
          description: The list of text chunking configurations.
          items:
            $ref: '#/components/schemas/TextChunkingConfig'
          title: textChunkingConfigs
          type: array
      required:
      - textChunkingConfigs
      title: SupportedTextChunkingResponse
      type: object
    SynapseDataStreamer:
      description: Stream CSV data chunks from Azure Synapse
      properties:
        cloudStorageCredentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the Azure credential holding information about
              a user with read access to the cloud storage.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the JDBC data source.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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:
      description: Stream CSV data chunks from Azure Synapse
      properties:
        cloudStorageCredentialId:
          description: The ID of the Azure credential holding information about a
            user with read access to the cloud storage.
          type:
          - string
          - 'null'
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the JDBC data source.
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks to Azure Synapse in bulk
      properties:
        cloudStorageCredentialId:
          description: The ID of the credential holding information about a user with
            write access to the cloud storage.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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:
      description: Save CSV data chunks to Azure Synapse in bulk
      properties:
        cloudStorageCredentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the cloud storage.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the JDBC data source.
            type:
            - string
            - 'null'
          - enum:
            - '[redacted]'
            type: string
          - type: 'null'
        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
    SyntheticEvaluationDatasetGenerationRequest:
      description: The body of the "Generate synthetic evaluation dataset" request.
      properties:
        datasetName:
          anyOf:
          - maxLength: 255
            type: string
          - type: 'null'
          description: The name to use for the generated dataset.
          title: datasetName
        language:
          anyOf:
          - type: string
          - type: 'null'
          description: The language to use for the generated dataset.
          title: language
        llmId:
          description: The ID of the LLM to use for synthetic dataset generation.
          title: llmId
          type: string
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: If specified, uses these LLM settings for the prompt and updates
            the settings of the corresponding chat or LLM blueprint to use these LLM
            settings.
          title: llmSettings
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the vector database to use for synthetic dataset
            generation.
          title: vectorDatabaseId
      required:
      - llmId
      title: SyntheticEvaluationDatasetGenerationRequest
      type: object
    SyntheticEvaluationDatasetGenerationResponse:
      description: The body of the "Create synthetic evaluation dataset" response.
      properties:
        datasetId:
          description: The ID of the created dataset.
          title: datasetId
          type: string
        promptColumnName:
          description: The name of the dataset column containing the prompt text.
          title: promptColumnName
          type: string
        responseColumnName:
          description: The name of the dataset column containing the response text.
          title: responseColumnName
          type: string
      required:
      - datasetId
      - promptColumnName
      - responseColumnName
      title: SyntheticEvaluationDatasetGenerationResponse
      type: object
    TTLTrigger:
      additionalProperties: false
      description: 'Trigger based on time-to-live (session age).


        Fires when the session age exceeds the configured TTL threshold.'
      properties:
        ttl:
          description: Time-to-live in seconds
          exclusiveMinimum: 0.0
          maximum: 63072000.0
          title: Ttl
          type: integer
      required:
      - ttl
      title: TTLTrigger
      type: object
    TableDescription:
      properties:
        catalog:
          description: The name of the catalog.
          type:
          - string
          - 'null'
        name:
          description: The name of the table.
          type: string
        schema:
          description: The schema of the table.
          type: string
        type:
          description: The type of table.
          enum:
          - TABLE
          - VIEW
          type: string
      required:
      - name
      - type
      type: object
    TableSampleArgumentsCreate:
      description: The sampling config.
      properties:
        percent:
          description: The percent of the table to be sampled.
          maximum: 100
          minimum: 0
          type: number
        seed:
          default: 0
          description: The starting number of the random number generator.
          minimum: 0
          type: integer
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
      required:
      - percent
      - skip
      type: object
      x-versionadded: v2.35
    TagInfo:
      additionalProperties: false
      properties:
        id:
          description: Unique identifier of the tag
          title: Id
          type: string
        name:
          description: Name of the tag
          title: Name
          type: string
        value:
          description: Value of the tag
          title: Value
          type: string
      required:
      - id
      - name
      - value
      title: TagInfo
      type: object
    Tags:
      items:
        $ref: '#/components/schemas/TagInfo'
      type: array
    TargetBaseline:
      properties:
        classDistribution:
          description: Class distribution for all classes in the bucket, only for
            classification deployments.
          items:
            $ref: '#/components/schemas/ClassDistribution'
          maxItems: 10000
          type: array
        meanGeoCentroid:
          $ref: '#/components/schemas/GeoPoint'
          x-versionadded: v2.36
        meanPredictedValue:
          description: Mean predicted value for all rows in the bucket, only for regression
            deployments.
          type:
          - number
          - 'null'
        meanProbabilities:
          description: Mean predicted probabilities for all classes in the bucket,
            only for classification deployments
          items:
            $ref: '#/components/schemas/MeanProbability'
          maxItems: 10000
          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'
          maxItems: 10
          type: array
        predictionsWarningCount:
          description: The number of predictions with warning in the bucket
          type:
          - integer
          - 'null'
        rowCount:
          description: Number of rows in the bucket.
          type:
          - integer
          - 'null'
      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.
          type:
          - number
          - 'null'
        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'
        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.
          type:
          - string
          - 'null'
        segmentValue:
          default: ''
          description: The value of the `segmentAttribute` to segment on.
          type:
          - string
          - 'null'
          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:
      description: The target drift setting for the deployment.
      properties:
        enabled:
          description: Indicates whether target drift tracking is enabled for this
            deployment.
          type: boolean
      required:
      - enabled
      type: object
    TaskPlanItem:
      properties:
        column:
          description: Column to apply transformations to.
          type: string
        taskList:
          description: Tasks to apply to the specific column.
          items:
            $ref: '#/components/schemas/OneOfTransforms'
          maxItems: 15
          minItems: 1
          type: array
      required:
      - column
      - taskList
      type: object
      x-versionadded: v2.35
    Template:
      description: If not null, the template used to create the custom model.
      properties:
        modelType:
          description: The type of template the model was created from.
          enum:
          - nimModel
          - invalid
          type: string
          x-versionadded: v2.36
        templateId:
          description: The ID of the template used to create this custom model.
          type: string
          x-versionadded: v2.36
      required:
      - modelType
      - templateId
      type: object
      x-versionadded: v2.36
    TemplateMetadata:
      description: Specifies permanent metadata for the custom template.
      properties:
        classLabels:
          description: List of class names in case of creating a Binary or a multiclass
            custom model.
          items:
            type: string
          maxItems: 1000
          type: array
          x-versionadded: v2.36
        readme:
          description: Content of README.md file of the template.
          maxLength: 1048576
          type:
          - string
          - 'null'
        resourceBundleIds:
          description: Custom template resource bundle IDs list.
          items:
            type: string
          maxItems: 1000
          type: array
          x-versionadded: v2.36
        source:
          $ref: '#/components/schemas/TemplateSource'
        tags:
          description: Custom template tags list.
          items:
            type: string
          maxItems: 1000
          type: array
        templateTypeSpecificResources:
          $ref: '#/components/schemas/TemplateTypeSpecificResources'
          x-versionadded: v2.36
      type: object
      x-versionadded: v2.36
    TemplatePermissionsResponse:
      description: The level of permissions for the user viewing this template.
      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
          type:
          - string
          - 'null'
        description:
          description: An overview of the template
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        labels:
          description: User-added filtering labels for the template
          items:
            type: string
          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'
        projectType:
          description: Type of project template.
          enum:
          - autoMl
          - textGeneration
          - timeSeries
          type:
          - string
          - 'null'
        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
    TemplateSource:
      description: Custom template source repo.
      type: object
      x-versionadded: v2.36
    TemplateTypeSpecificResources:
      description: Specifies resources for the custom template.
      properties:
        serviceWebRequestsOnRootPath:
          default: false
          description: Whether the 'service_web_requests_on_root_path' resource should
            be enabled on the custom app.
          type:
          - boolean
          - 'null'
      type: object
      x-versionadded: v2.36
    TenantResourceTypeItem:
      properties:
        id:
          description: 'Resource type: CPU/GPU.'
          type: string
        name:
          description: 'Resource type name: CPU usage/GPU usage.'
          type: string
      required:
      - id
      - name
      type: object
      x-versionadded: v2.39
    TenantResourceTypeResponse:
      properties:
        data:
          description: The available resource types.
          items:
            $ref: '#/components/schemas/TenantResourceTypeItem'
          maxItems: 2
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.39
    TenantResourceUtilizationItem:
      properties:
        metricDatetime:
          description: The date and time for the resource usage metric.
          type: string
        metricGroups:
          description: The groups of workload.
          items:
            $ref: '#/components/schemas/MetricGroups'
          maxItems: 100
          type: array
        resourceType:
          description: The resource type of the workload (GPU or CPU).
          type: string
        total:
          description: The resources utilized for all metric groups.
          type: number
      required:
      - metricDatetime
      - metricGroups
      - resourceType
      - total
      type: object
      x-versionadded: v2.39
    TenantResourceUtilizationResponse:
      properties:
        data:
          description: Resource usage records grouped by workload group and category
          items:
            $ref: '#/components/schemas/TenantResourceUtilizationItem'
          maxItems: 10000
          type: array
        hash:
          description: SHA-256 hash for file integrity verification.
          type: string
        licenseLimit:
          description: The license limit for the resource type.
          type: integer
        maxGroupUsages:
          description: Maximum resources utilized per groups of workload for period.
          items:
            $ref: '#/components/schemas/MetricGroups'
          maxItems: 1000
          type: array
        maxUsage:
          description: Maximum resources utilized for period.
          type: number
        metricName:
          description: The metric name.
          type: string
      required:
      - data
      - licenseLimit
      - maxGroupUsages
      - maxUsage
      - metricName
      type: object
      x-versionadded: v2.39
    TerminalSchema:
      description: Schema for a terminal.
      properties:
        createdAt:
          description: Creation time of the terminal.
          format: date-time
          title: Createdat
          type: string
        name:
          description: Name of the terminal.
          title: Name
          type: string
        terminalId:
          description: ID of the terminal.
          title: Terminalid
          type: string
      required:
      - terminalId
      - name
      - createdAt
      title: TerminalSchema
      type: object
    TerminalsResponseSchema:
      description: Schema for the list of terminals in a notebook.
      properties:
        count:
          default: 0
          description: The total of paginated results.
          title: Count
          type: integer
        data:
          description: List of terminals in a notebook.
          items:
            $ref: '#/components/schemas/TerminalSchema'
          title: Data
          type: array
        next:
          description: The URL to fetch the next batch of results.
          title: Next
          type: string
        previous:
          description: The URL to fetch the previous batch of results.
          title: Previous
          type: string
        totalCount:
          default: 0
          description: The total of all results.
          title: Totalcount
          type: integer
      title: TerminalsResponseSchema
      type: object
    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.
      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'
        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
    TextChunkingConfig:
      description: API response object for a single text chunking configuration.
      properties:
        defaultMethod:
          description: The name of the default text chunking method.
          title: defaultMethod
          type: string
        embeddingModel:
          anyOf:
          - $ref: '#/components/schemas/EmbeddingModelNames'
          - $ref: '#/components/schemas/CustomEmbeddingModelNames'
          description: The name of the embedding model.
          title: embeddingModel
        methods:
          description: The list of text chunking methods.
          items:
            $ref: '#/components/schemas/TextChunkingMethod'
          title: methods
          type: array
      required:
      - embeddingModel
      - methods
      - defaultMethod
      title: TextChunkingConfig
      type: object
    TextChunkingMethod:
      description: API response object for a single text chunking method.
      properties:
        chunkingMethod:
          $ref: '#/components/schemas/ChunkingMethodNames'
          description: The name of the text chunking method.
        chunkingParameters:
          description: The list of text chunking parameters.
          items:
            $ref: '#/components/schemas/TextChunkingParameterFields'
          title: chunkingParameters
          type: array
        description:
          description: The description of the text chunking method.
          title: description
          type: string
        title:
          $ref: '#/components/schemas/ChunkingMethodNamesTitle'
          description: User-friendly label for the text chunking method.
      required:
      - chunkingMethod
      - title
      - chunkingParameters
      - description
      title: TextChunkingMethod
      type: object
    TextChunkingParameterFields:
      description: API response object for a single text chunking parameter.
      properties:
        default:
          anyOf:
          - type: integer
          - items:
              type: string
            type: array
          - type: boolean
          description: The default value of the parameter.
          title: default
        description:
          description: The description of the parameter.
          title: description
          type: string
        max:
          anyOf:
          - type: integer
          - type: 'null'
          description: The maximum value of the parameter (inclusive).
          title: max
        min:
          anyOf:
          - type: integer
          - type: 'null'
          description: The minimum value of the parameter (inclusive).
          title: min
        name:
          description: The name of the parameter.
          title: name
          type: string
        type:
          $ref: '#/components/schemas/ChunkingParameterTypes'
          description: The data type of the parameter.
      required:
      - name
      - type
      - min
      - max
      - description
      - default
      title: TextChunkingParameterFields
      type: object
    TextFeature:
      properties:
        featureImpact:
          description: Feature Impact score.
          type:
          - number
          - 'null'
        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:
      description: End of the feature derivation window applied.
      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:
      description: An object with the keys "start" and "end" defining the period.
      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
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      type: object
    TimeSeriesDirective:
      properties:
        arguments:
          $ref: '#/components/schemas/TimeSeriesDirectiveArguments'
        directive:
          description: Time series processing directive, which prepares the dataset
            for time series modeling. All windows are row-based.
          enum:
          - time-series
          type: string
      required:
      - arguments
      - directive
      type: object
      x-versionadded: v2.35
    TimeSeriesDirectiveArguments:
      description: Time series directive arguments.
      properties:
        baselinePeriods:
          default:
          - 1
          description: A list of periodicities used to calculate naive target features.
          items:
            exclusiveMinimum: 0
            type: integer
          maxItems: 10
          minItems: 1
          type: array
        datetimePartitionColumn:
          description: The column that is used to order the data.
          type: string
        forecastDistances:
          description: A list of forecast distances, which defines the number of rows
            into the future to predict.
          items:
            exclusiveMinimum: 0
            type: integer
          maxItems: 20
          minItems: 1
          type: array
        forecastPoint:
          description: Filter output by given forecast point. Can be applied only
            at the prediction time.
          format: date-time
          type: string
        knownInAdvanceColumns:
          default: []
          description: Columns that are known in advance (future values are known).
            Values for these known columns must be specified at prediction time.
          items:
            type: string
          maxItems: 200
          type: array
        multiseriesIdColumn:
          default: null
          description: The series ID column, if present. This column partitions data
            to create a multiseries modeling project.
          type:
          - string
          - 'null'
        rollingMedianUserDefinedFunction:
          default: null
          description: "To optimize rolling median calculation with relational database\
            \ sources,\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\
            \         "
          type:
          - string
          - 'null'
        rollingMostFrequentUserDefinedFunction:
          default: null
          description: "To optimize rolling most frequent calculation with relational\
            \ database sources,\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         "
          type:
          - string
          - 'null'
        skip:
          default: false
          description: If True, this directive will be skipped during processing.
          type: boolean
          x-versionadded: v2.37
        targetColumn:
          description: The column intended to be used as the target for modeling.
            This parameter is required for generating naive features.
          type: string
        taskPlan:
          description: Task plan to describe time series specific transformations.
          items:
            $ref: '#/components/schemas/TaskPlanItem'
          maxItems: 200
          minItems: 1
          type: array
      required:
      - datetimePartitionColumn
      - forecastDistances
      - skip
      - targetColumn
      - taskPlan
      type: object
      x-versionadded: v2.35
    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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalLogLines:
          description: The total number of lines in the feature derivation log.
          type: integer
      required:
      - count
      - featureLog
      - next
      - previous
      - totalLogLines
      type: object
    TimeSeriesOptions:
      description: Time Series project option used to build new models.
      properties:
        calendarId:
          description: The ID of the calendar to be used in this project.
          type:
          - string
          - 'null'
        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
          - 'null'
        exponentiallyWeightedMovingAlpha:
          description: Discount factor (alpha) used for exponentially weighted moving
            features
          exclusiveMinimum: 0.0
          maximum: 1.0
          type:
          - number
          - 'null'
        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
          - 'null'
      type: object
    TimeSeriesProperties:
      description: Properties related to time series data prep.
      properties:
        isMostlyImputed:
          default: null
          description: Whether more than half of the rows are imputed.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.26
      required:
      - isMostlyImputed
      type: object
    TimelinessSettings:
      description: Predictions timeliness health setting.
      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
    TokenCountTrigger:
      additionalProperties: false
      description: 'Trigger based on token count.


        Fires when the session''s total token count reaches or exceeds the configured
        threshold.

        Tokens are calculated from event message content using tiktoken.'
      properties:
        tokenCount:
          description: Token count threshold
          exclusiveMinimum: 0.0
          maximum: 100000000.0
          title: Tokencount
          type: integer
      required:
      - tokenCount
      title: TokenCountTrigger
      type: object
    ToolCallAccuracySettings:
      description: Additional arguments for the tool call accuracy metric.
      properties:
        argumentComparison:
          $ref: '#/components/schemas/ArgumentMatchMode'
          description: Setting defining how arguments of tool calls should be compared
            during the metric computation.
      required:
      - argumentComparison
      title: ToolCallAccuracySettings
      type: object
    ToolField:
      properties:
        callCount:
          description: The number of times tools were used in a trace.
          type: integer
        name:
          description: The name of the tool.
          type: string
      required:
      - callCount
      - name
      type: object
      x-versionadded: v2.4
    TraceChat:
      description: Reference to a chat or comparison chat available in a trace.
      properties:
        id:
          description: The ID of the chat associated with the trace.
          title: id
          type: string
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the chat associated with the trace.
          title: name
      required:
      - id
      - name
      title: TraceChat
      type: object
    TraceDatasetResponse:
      description: API response for prompt traces export request.
      properties:
        aiCatalogId:
          description: The Data Registry dataset ID.
          title: aiCatalogId
          type: string
      required:
      - aiCatalogId
      title: TraceDatasetResponse
      type: object
    TraceMetadataResponse:
      description: API response for prompt trace metadata retrieval request.
      properties:
        chats:
          description: The list of combined chat and comparison prompt chats available
            in trace.
          items:
            $ref: '#/components/schemas/TraceChat'
          title: chats
          type: array
        users:
          description: The list of unique users available in the trace response.
          items:
            $ref: '#/components/schemas/DataRobotUser'
          title: users
          type: array
      required:
      - users
      - chats
      title: TraceMetadataResponse
      type: object
    TraceView:
      properties:
        completion:
          description: The completion of the trace.
          type:
          - string
          - 'null'
        cost:
          description: The cost of the trace.
          type: number
        duration:
          description: The duration of the trace.
          type: number
        errorSpansCount:
          description: The number of error spans.
          type: integer
        prompt:
          description: The prompt of the trace.
          type:
          - string
          - 'null'
        rootServiceName:
          description: The root service name.
          type: string
        rootSpanName:
          description: The root span name.
          type: string
        spansCount:
          description: The number of spans.
          type: integer
        timestamp:
          description: The timestamp of the trace.
          type: number
        tools:
          default: null
          description: A list of tool names used in the trace. Extracted from span
            attributes, includes all tools encountered in the trace.
          items:
            $ref: '#/components/schemas/ToolField'
          maxItems: 100
          type: array
          x-versionadded: v2.39
        traceId:
          description: The OTel trace ID.
          maxLength: 32
          minLength: 32
          type: string
        userInfo:
          $ref: '#/components/schemas/TracingUserInfo'
          x-versionadded: v2.45
      required:
      - completion
      - cost
      - duration
      - errorSpansCount
      - prompt
      - rootServiceName
      - rootSpanName
      - spansCount
      - timestamp
      - tools
      - traceId
      type: object
      x-versionadded: v2.37
    TracingContextEntityType:
      description: Type of an entity in context of which the agent request is performed.
      enum:
      - deployment
      - use_case
      title: TracingContextEntityType
      type: string
    TracingEvaluationMetrics:
      description: Metric values produced by DataRobot moderations.
      properties:
        promptGuards:
          additionalProperties:
            oneOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
          description: Prompt guard values produced by DataRobot moderations.
          type: object
        responseGuards:
          additionalProperties:
            oneOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
          description: Prompt guard values produced by DataRobot moderations.
          type: object
      type: object
      x-versionadded: v2.37
    TracingListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
          x-versionadded: v2.44
        data:
          description: The list of traces.
          items:
            $ref: '#/components/schemas/TraceView'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        total:
          description: The total number of traces.
          type: integer
          x-versiondeprecated: v2.44
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.44
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    TracingRetrieveResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
          x-versionadded: v2.46
        duration:
          description: The duration of the trace.
          type:
          - number
          - 'null'
        metrics:
          $ref: '#/components/schemas/TracingEvaluationMetrics'
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.46
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.46
        rootServiceName:
          description: The root service name.
          type:
          - string
          - 'null'
        rootSpanName:
          description: The root span name.
          type:
          - string
          - 'null'
        spanCount:
          description: The number of spans.
          type: integer
        spans:
          description: The list of spans.
          items:
            $ref: '#/components/schemas/SpanView'
          maxItems: 1000
          type: array
        totalCount:
          description: The total number of items across all pages.
          type: integer
          x-versionadded: v2.46
        traceId:
          description: The OTel trace ID.
          maxLength: 32
          minLength: 32
          type: string
      required:
      - duration
      - next
      - previous
      - rootServiceName
      - rootSpanName
      - spanCount
      - spans
      - totalCount
      - traceId
      type: object
      x-versionadded: v2.37
    TracingUserInfo:
      description: User metadata derived from the trace root user id.
      properties:
        fullName:
          description: The full name of the user associated with the span.
          type: string
        userId:
          description: The ID of the user associated with the span.
          type: string
        username:
          description: The username of the user associated with the span.
          type: string
      required:
      - fullName
      - userId
      - username
      type: object
      x-versionadded: v2.45
    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: 100
          exclusiveMinimum: 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: 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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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: 100
          exclusiveMinimum: 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: 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: The file compression for the data stage. Only supports CSV
            storage type.
          enum:
          - zip
          - bz2
          - gzip
          type: string
          x-versionadded: v2.33
        dataStageDelimiter:
          description: The file delimiter for the data stage specified as a string.
          type: string
          x-versionadded: v2.33
        dataStageEncoding:
          description: The file encoding for the data stage.
          enum:
          - UTF-8
          - ASCII
          - WINDOWS-1252
          type: string
          x-versionadded: v2.33
        dataStageId:
          description: The data stage ID. The data stage must be finalized and not
            expired.
          type: string
          x-versionadded: v2.33
        dataStageStorageType:
          default: csv
          description: The file type of the data stage contents.
          enum:
          - csv
          - parquet
          type: string
          x-versionadded: v2.33
        modelId:
          description: The 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.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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: 0
          maximum: 100
          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:
      description: Training data configuration.
      properties:
        message:
          description: Training data assignment error message
          maxLength: 10000
          type:
          - string
          - 'null'
          x-versionadded: v2.31
      type: object
    TrainingDataEntry:
      description: A training data entry.
      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.
          type:
          - string
          - 'null'
          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 the training data export.
          type: string
          x-versionadded: v2.33
        data:
          $ref: '#/components/schemas/TrainingDataEntry'
          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: The 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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: URL to the previous page, or null if there is no such page.
          type:
          - string
          - 'null'
          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:
      description: Training data configuration.
      properties:
        assignmentError:
          $ref: '#/components/schemas/TrainingDataAssignmentErrorResponse'
          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.
          type:
          - string
          - 'null'
        datasetName:
          description: A user-friendly name for the dataset.
          maxLength: 255
          type:
          - string
          - 'null'
        datasetVersionId:
          description: The ID of the dataset version.
          type:
          - string
          - 'null'
      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:
      description: holdout and prediction training data details
      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: The number of items returned on this page.
          type: integer
        data:
          description: A list of training prediction jobs
          items:
            $ref: '#/components/schemas/TraningPredictions'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    TrainingPredictionsRetrieveResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A list of training prediction rows
          items:
            $ref: '#/components/schemas/TraningPredictionRow'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
    TraningPredictionRow:
      description: A training prediction row
      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.
          type:
          - integer
          - 'null'
        forecastPoint:
          description: (if time series project) The forecastPoint of the predictions.
            Either provided or inferred.
          format: date-time
          type:
          - string
          - 'null'
        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'
          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: The list of predicted values for this row.
          items:
            $ref: '#/components/schemas/PredictionArrayObjectValues'
          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.
          type:
          - string
          - 'null'
        shapMetadata:
          $ref: '#/components/schemas/TraningPredictionShapMetadata'
          x-versionadded: v2.21
        timestamp:
          description: (if time series project) The timestamp of this row in the prediction
            dataset.
          format: date-time
          type:
          - string
          - 'null'
      required:
      - partitionId
      - prediction
      - rowId
      type: object
    TraningPredictionShapMetadata:
      description: The additional information necessary to understand shap based prediction
        explanations. Only present if explanationAlgorithm="shap" was added in compute
        request.
      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:
      description: A training prediction job
      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
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
        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'
          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
    TransformationPlanResponse:
      properties:
        id:
          description: The identifier of the transformation plan.
          type: string
        inputParameters:
          $ref: '#/components/schemas/InputParametersResponse'
        status:
          description: Transformation preparation status
          enum:
          - INITIALIZED
          - COMPLETED
          - ERROR
          type: string
        suggestedOperations:
          description: The list of operations to apply to a recipe to get the dataset
            ready for time series modeling.
          items:
            $ref: '#/components/schemas/TimeSeriesDirective'
          maxItems: 10
          type: array
      required:
      - id
      - inputParameters
      - status
      - suggestedOperations
      type: object
      x-versionadded: v2.35
    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:
      description: Retraining policy trigger.
      properties:
        customJobId:
          description: Deprecated - The ID of the custom job to be used in this policy.
          type:
          - string
          - 'null'
          x-versionadded: v2.37
          x-versiondeprecated: v2.38
        minIntervalBetweenRuns:
          description: Minimal interval between policy runs in ISO 8601 duration string.
          type:
          - string
          - 'null'
        schedule:
          $ref: '#/components/schemas/Schedule'
        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.
          type:
          - boolean
          - 'null'
        type:
          description: Type of retraining policy trigger.
          enum:
          - schedule
          - data_drift_decline
          - accuracy_decline
          - null
          type: string
      required:
      - type
      type: object
    TriggeredNotebookExecutionRequest:
      description: Request payload values for executing a notebook with parameters.
      properties:
        parameters:
          description: List of parameters to use as environment variables during execution.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - path
      title: TriggeredNotebookExecutionRequest
      type: object
    TrinoDataStreamer:
      description: Stream CSV data chunks from Trino using browser-trino
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with read access to the data source.
            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 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:
          - trino
          type: string
      required:
      - catalog
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.41
    TrinoIntake:
      description: Stream CSV data chunks from Trino using browser-trino
      properties:
        catalog:
          description: The name of the specified database catalog to read input data
            from.
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            read access to the data source.
          type: string
        dataStoreId:
          description: ID of the data store to connect to
          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:
          - trino
          type: string
      required:
      - catalog
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.41
    TrinoOutput:
      description: Saves CSV data chunks to Trino using browser-trino
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
        credentialId:
          description: The ID of the credential holding information about a user with
            write access to the data destination.
          type: string
        dataStoreId:
          description: The ID of the data store to connect to
          type: string
        schema:
          description: The name of the specified database schema to write output data
            to.
          type: string
        table:
          description: The name of the specified database table to write output data
            to.
          type: string
        type:
          description: The type name for this output type
          enum:
          - trino
          type: string
      required:
      - catalog
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.41
    TrinoOutputAdaptor:
      description: Saves CSV data chunks to Trino using browser-trino
      properties:
        catalog:
          description: The name of the specified database catalog to write output
            data to.
          type: string
        credentialId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The ID of the credential holding information about a user
              with write access to the data destination.
            type: string
          - enum:
            - '[redacted]'
            type: string
        dataStoreId:
          description: Either the populated value of the field or [redacted] due to
            permission settings
          oneOf:
          - description: The 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 output data
            to.
          type: string
        table:
          description: The name of the specified database table to write output data
            to.
          type: string
        type:
          description: The type name for this output type
          enum:
          - trino
          type: string
      required:
      - catalog
      - credentialId
      - dataStoreId
      - schema
      - table
      - type
      type: object
      x-versionadded: v2.41
    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
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            type: array
      required:
      - parameterId
      - value
      type: object
    TuningParameters:
      properties:
        constraints:
          $ref: '#/components/schemas/Constraints'
        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
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            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
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            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
    UnsupervisedClusteringModelRecordResponse:
      properties:
        blenderModels:
          description: Models that are in the blender.
          items:
            type: integer
          maxItems: 100
          type: array
          x-versionadded: v2.36
        blueprintId:
          description: The blueprint used to construct the model.
          type: string
        externalPredictionModel:
          description: If the model is an external prediction model.
          type: boolean
          x-versionadded: v2.36
        featurelistId:
          description: The ID of the feature list used by the model.
          type:
          - string
          - 'null'
        featurelistName:
          description: The name of the feature list used by the model. If null, themodel
            was trained on multiple feature lists.
          type:
          - string
          - 'null'
        frozenPct:
          description: The training percent used to train the frozen model.
          type:
          - number
          - 'null'
          x-versionadded: v2.36
        hasCodegen:
          description: If the model has a codegen JAR file.
          type: boolean
          x-versionadded: v2.36
        icons:
          description: The icons associated with the model.
          type:
          - integer
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the model.
          type: string
        isBlender:
          description: If the model is a blender.
          type: boolean
          x-versionadded: v2.36
        isCustom:
          description: If the model contains custom tasks.
          type: boolean
          x-versionadded: v2.36
        isFrozen:
          description: Indicates whether the model is frozen, i.e., uses tuning parameters
            from a parent model.
          type: boolean
        isStarred:
          description: Indicates 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 when the 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
        isTransparent:
          description: If the model is a transparent model with exposed coefficients.
          type: boolean
          x-versionadded: v2.36
        isUserModel:
          description: If the model was created with Composable ML.
          type: boolean
          x-versionadded: v2.36
        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.
          type: object
        modelCategory:
          description: Indicates the type 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 full name of the family that the model belongs to (e.g.,
            Support Vector Machine, Gradient Boosting Machine, etc.).
          type: string
        modelNumber:
          description: The model number from the Leaderboard.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
        modelType:
          description: Identifies the model (e.g., `Nystroem Kernel SVM Regressor`).
          type: string
        numberOfClusters:
          description: The number of clusters in the unsupervised clustering model.
            Only present in unsupervised clustering projects.
          type:
          - integer
          - 'null'
          x-versionadded: v2.34
        parentModelId:
          description: The ID of the parent model if the model is frozen or a result
            of incremental learning. Null otherwise.
          type:
          - string
          - 'null'
        processes:
          description: The list of processes used by the model.
          items:
            type: string
          maxItems: 100
          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: 0
          type:
          - number
          - 'null'
        trainingRowCount:
          description: The number of rows used to train the model.
          exclusiveMinimum: 0
          type:
          - integer
          - 'null'
      required:
      - blenderModels
      - blueprintId
      - externalPredictionModel
      - featurelistId
      - featurelistName
      - frozenPct
      - hasCodegen
      - icons
      - id
      - isBlender
      - isCustom
      - isFrozen
      - isStarred
      - isTrainedIntoHoldout
      - isTrainedIntoValidation
      - isTrainedOnGpu
      - isTransparent
      - isUserModel
      - metrics
      - modelCategory
      - modelFamily
      - modelNumber
      - modelType
      - numberOfClusters
      - parentModelId
      - processes
      - projectId
      - samplePct
      - trainingRowCount
      type: object
      x-versionadded: v2.34
    UpdateAccessControl:
      properties:
        role:
          description: The role to set for the user.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type:
          - string
          - 'null'
        username:
          description: The username of the user to set the role for.
          type: string
      required:
      - role
      - username
      type: object
    UpdateArtifactRequest:
      additionalProperties: false
      description: 'Request to update an artifact.


        When updating an artifact, the user_id and tenant_id cannot be changed.

        Currently transferring of ownership of an artifact is not supported.'
      properties:
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Description of the artifact
          title: Description
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: Name of the artifact
          title: Name
        spec:
          anyOf:
          - $ref: '#/components/schemas/MultiContainerArtifactSpec'
          - type: 'null'
          description: Artifact specification
        status:
          anyOf:
          - $ref: '#/components/schemas/ArtifactStatus'
          - type: 'null'
          description: Artifact status
      title: UpdateArtifactRequest
      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
    UpdateCellRequest:
      description: Request schema for updating a notebook cell.
      properties:
        afterCellId:
          anyOf:
          - type: string
          - enum:
            - FIRST
            type: string
          description: The ID of the cell after which to create the new cell.
          title: Aftercellid
        attachments:
          description: The attachments associated with the cell.
          title: Attachments
          type: object
        md5:
          description: The MD5 hash of the cell.
          title: Md5
          type: string
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: The metadata associated with the cell.
          title: Metadata
        source:
          description: Contents of the cell, represented as a string.
          title: Source
          type: string
      required:
      - md5
      title: UpdateCellRequest
      type: object
    UpdateCellsRequest:
      description: Request payload values for updating notebook cells.
      properties:
        actionId:
          description: Action ID of notebook update request.
          maxLength: 64
          title: Actionid
          type: string
        cells:
          description: List of updated notebook cells.
          items:
            $ref: '#/components/schemas/UpdateNotebookCellSchema'
          title: Cells
          type: array
        generation:
          description: Integer representing the generation of the notebook.
          title: Generation
          type: integer
        path:
          description: Path to the notebook.
          title: Path
          type: string
      required:
      - generation
      - path
      - cells
      title: UpdateCellsRequest
      type: object
    UpdateClientActivityRequest:
      description: Empty payload used when updating the client activity for a notebook
        session.
      properties: {}
      title: UpdateClientActivityRequest
      type: object
    UpdateConnectedVectorDatabaseRequest:
      description: The body of the "Update connected vector database" request.
      properties:
        datasetId:
          description: The ID of the dataset to use for building the vector database.
          title: datasetId
          type: string
        metadataCombinationStrategy:
          $ref: '#/components/schemas/MetadataCombinationStrategy'
          default: replace
          description: The strategy to use when the dataset and the metadata file
            have duplicate columns.
        metadataDatasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the dataset to add metadata for building the vector
            database.
          title: metadataDatasetId
      required:
      - datasetId
      title: UpdateConnectedVectorDatabaseRequest
      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
            maxItems: 1000
            type: array
          x-versionadded: v2.33
        filesToDelete:
          description: The IDs of the files to be deleted.
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            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'
          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
        runtimeParameters:
          description: Full snapshot of runtime parameters. Parameters not in this
            list will be removed. Supports create, update, and delete operations.
          type: string
          x-datarobot-public-preview: false
          x-datarobot-required-feature-flags:
          - description: Enables the addition of key-value pairs as Runtime-Parameters
              for Custom Inference Models.
            enabled_by_default: true
            maturity: GA_ALL
            name: CUSTOM_MODEL_RUNTIME_PARAMETERS
      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'
          type:
          - string
          - 'null'
        configurationId:
          description: Driver configuration ID if it was provided during driver upload.
          type:
          - string
          - 'null'
          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
    UpdateEventRequest:
      description: Schema for create event request.
      properties:
        body:
          anyOf:
          - $ref: '#/components/schemas/EventBody'
          - type: 'null'
          description: Updated event body.
        emitter:
          anyOf:
          - $ref: '#/components/schemas/EmitterDataModel'
          - type: 'null'
          description: Updated emitter information.
        type:
          anyOf:
          - $ref: '#/components/schemas/EventType'
          - type: 'null'
          description: Updated event type.
      title: UpdateEventRequest
      type: object
    UpdateExposedPortSchema:
      description: Port update schema for a notebook.
      properties:
        description:
          description: Description of the exposed port.
          maxLength: 500
          title: Description
          type: string
        port:
          description: Exposed port number.
          title: Port
          type: integer
      title: UpdateExposedPortSchema
      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
    UpdateFileDeleted:
      type: object
      x-versionadded: v2.37
    UpdateFilesystemObjectMetadata:
      description: Update filesystem object metadata path and values.
      properties:
        metadata:
          allOf:
          - $ref: '#/components/schemas/DRFileMetadata'
          description: Metadata to update.
          title: Metadata
        path:
          description: Path to the filesystem object.
          title: Path
          type: string
      required:
      - path
      - metadata
      title: UpdateFilesystemObjectMetadata
      type: object
    UpdateFilesystemObjectsMetadataRequest:
      description: Request payload values for updating filesystem object metadata.
      properties:
        updates:
          description: List of updates to apply.
          items:
            $ref: '#/components/schemas/UpdateFilesystemObjectMetadata'
          title: Updates
          type: array
      title: UpdateFilesystemObjectsMetadataRequest
      type: object
    UpdateLLMBlueprintRequest:
      description: The body of the Update LLM Blueprint request.
      properties:
        description:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, updates the LLM blueprint description to this
            value.
          title: description
        isSaved:
          anyOf:
          - type: boolean
          - type: 'null'
          description: If specified, updates the saved status of the LLM blueprint
            to this value.
          title: isSaved
        isStarred:
          anyOf:
          - type: boolean
          - type: 'null'
          description: If specified, updates the starred status of the LLM blueprint
            to this value.
          title: isStarred
        llmId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, changes the LLM used by the LLM blueprint.
          title: llmId
        llmSettings:
          anyOf:
          - $ref: '#/components/schemas/CommonLLMSettings'
          - $ref: '#/components/schemas/CustomModelLLMSettings'
          - $ref: '#/components/schemas/CustomModelChatLLMSettings'
          - type: 'null'
          description: If specified, updates the LLM settings to these values.
          title: llmSettings
        name:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: If specified, renames the LLM blueprint to this value.
          title: name
        promptType:
          anyOf:
          - $ref: '#/components/schemas/PromptType'
          - type: 'null'
          description: If specified, updates the chat context behavior of the LLM
            blueprint to this value.
        vectorDatabaseId:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, changes the vector database used by the LLM blueprint.
            If the specified value is `null`, unlinks the vector database from the
            LLM blueprint. If omitted, the currently used vector database remains
            in use.
          title: vectorDatabaseId
        vectorDatabaseSettings:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettingsRequest'
          - type: 'null'
          description: If specified, updates the vector database retrieval settings
            to these values.
      title: UpdateLLMBlueprintRequest
      type: object
    UpdateMemorySpaceRequest:
      additionalProperties: false
      description: Request body for partially updating a Memory Space
      properties:
        customInstructions:
          anyOf:
          - maxLength: 10000
            type: string
          - type: 'null'
          description: Updated custom prompt instructions used for fact extraction.
            Pass null to clear and revert to mem0's default extraction prompt.
          title: Custominstructions
        description:
          anyOf:
          - maxLength: 1000
            type: string
          - type: 'null'
          description: Updated description for the memory space.
          title: Description
        llmBaseUrl:
          anyOf:
          - format: uri
            maxLength: 2083
            minLength: 1
            type: string
          - type: 'null'
          description: Chat API URL to use for memory extraction.
          title: Llmbaseurl
        llmModelName:
          anyOf:
          - maxLength: 200
            type: string
          - type: 'null'
          description: Updated LLM model name. Non-reasoning models such as ``gpt-4o``
            are recommended. Reasoning-capable models are significantly slower for
            fact extraction without producing meaningfully better results.
          title: Llmmodelname
      title: UpdateMemorySpaceRequest
      type: object
    UpdateNotebookCellSchema:
      description: The schema for the updated notebook cell.
      properties:
        cellType:
          allOf:
          - $ref: '#/components/schemas/SupportedCellTypes'
          description: Type of the cell.
        id:
          description: ID of the cell.
          title: Id
          type: string
        metadata:
          allOf:
          - $ref: '#/components/schemas/NotebookCellMetadata'
          description: Metadata of the cell.
          title: Metadata
        source:
          anyOf:
          - type: string
          - items:
              type: string
            type: array
          description: Contents of the cell, represented as a string.
          title: Source
      required:
      - id
      title: UpdateNotebookCellSchema
      type: object
    UpdateNotebookRequest:
      description: Request schema for updating a notebook.
      properties:
        description:
          description: The value to update the description of the notebook to.
          title: Description
          type: string
        name:
          description: The value to update the name of the notebook to.
          title: Name
          type: string
        settings:
          allOf:
          - $ref: '#/components/schemas/NotebookSettings'
          description: The value to update the settings of the notebook to.
          title: Settings
        tags:
          description: The value to update the tags of the notebook to.
          items:
            type: string
          title: Tags
          type: array
        useCaseId:
          description: The value to update the Use Case ID of the notebook to.
          title: Usecaseid
          type: string
      title: UpdateNotebookRequest
      type: object
    UpdateNotebookRevisionRequest:
      description: Request
      properties:
        isAuto:
          default: false
          description: Whether the revision is autosaved.
          title: Isauto
          type: boolean
        name:
          description: Notebook revision name.
          minLength: 1
          title: Name
          type: string
        notebookPath:
          description: Path to the notebook file, if using Codespaces.
          title: Notebookpath
          type: string
      title: UpdateNotebookRevisionRequest
      type: object
    UpdateScheduledJobRequest:
      description: Request to update an existing scheduled job.
      properties:
        enabled:
          description: Whether the job is enabled.
          title: Enabled
          type: boolean
        parameters:
          description: The parameters to pass to the notebook when it runs.
          items:
            $ref: '#/components/schemas/ScheduledJobParam'
          title: Parameters
          type: array
        schedule:
          allOf:
          - $ref: '#/components/schemas/Schedule'
          description: The schedule for the job.
          title: Schedule
        title:
          description: The title of the scheduled job.
          maxLength: 100
          minLength: 1
          title: Title
          type: string
        useCaseId:
          description: The ID of the use case this notebook is associated with.
          title: Usecaseid
          type: string
      required:
      - useCaseId
      title: UpdateScheduledJobRequest
      type: object
    UpdateSessionRequest:
      description: Schema for session partial patch-updates.
      properties:
        description:
          anyOf:
          - maxLength: 1000
            type: string
          - type: 'null'
          description: New session description.
          title: Description
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Custom metadata as key-value pairs for storing application-specific
            data
          title: Metadata
      title: UpdateSessionRequest
      type: object
    UpdateSettingsRequest:
      additionalProperties: false
      description: Request to update runtime settings for a workload.
      properties:
        runtime:
          $ref: '#/components/schemas/WorkloadRuntime'
          description: Runtime configuration to apply to the workload
      required:
      - runtime
      title: UpdateSettingsRequest
      type: object
    UpdateSsoConfiguration:
      properties:
        advancedConfiguration:
          $ref: '#/components/schemas/SamlAdvancedConfiguration'
        attributeMapping:
          $ref: '#/components/schemas/EnhancedSamlAttributeMapping'
        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'
        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'
          maxItems: 100
          type: array
        idpMetadata:
          $ref: '#/components/schemas/SamlMetadataFile'
        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
        organizationMapping:
          description: The list of DataRobot organization to identity provider organization
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlOrganizationMapping'
          maxItems: 100
          type: array
          x-versionadded: v2.37
        roleMapping:
          description: The list of DataRobot access role to identity provider role
            maps.
          items:
            $ref: '#/components/schemas/EnhancedSamlRoleMapping'
          maxItems: 100
          type: array
        securityParameters:
          $ref: '#/components/schemas/SamlSecurityParameters'
        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
    UpdateTerminalSchema:
      description: Schema for updating a terminal.
      properties:
        name:
          description: Name to update the terminal with.
          title: Name
          type: string
      required:
      - name
      title: UpdateTerminalSchema
      type: object
    UpdateWorkloadRequest:
      additionalProperties: false
      description: Request to update an existing workload.
      properties:
        description:
          anyOf:
          - type: string
          - type: 'null'
          description: Updated workload description
          title: Description
        importance:
          anyOf:
          - $ref: '#/components/schemas/WorkloadImportance'
          - type: 'null'
          description: Updated workload importance level
        name:
          anyOf:
          - maxLength: 5000
            minLength: 1
            type: string
          - type: 'null'
          description: Updated workload name
          title: Name
      title: UpdateWorkloadRequest
      type: object
    UploadRatingTable:
      properties:
        parentModelId:
          description: The parent model this rating table file was derived from.
          type: string
        ratingTableFile:
          description: 'The 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
            - SAMPLE
            - SINGLE_SERIES_CALENDAR
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - MULTI_SERIES_CALENDAR
              - PREDICTION
              - SAMPLE
              - 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'
          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:
        events:
          additionalProperties:
            type: string
          description: The available events to use in filtering.
          type: object
          x-versionadded: v2.36
      required:
      - events
      type: object
    UsageDataExport:
      properties:
        end:
          description: The upper bound of stored events timestamp to include within
            the artifact.
          format: date-time
          type:
          - string
          - 'null'
        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
          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
          type:
          - string
          - 'null'
        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
    UsageItem:
      properties:
        cloud:
          description: Cloud provider where workload was executed
          type: string
          x-versionadded: v2.41
        cloudRegion:
          description: Cloud region where workload was executed
          type: string
          x-versionadded: v2.41
        cost:
          description: Cost for the usage
          type: number
          x-versionadded: v2.41
        currency:
          default: USD
          description: The price currency.
          enum:
          - usd
          - Usd
          - USD
          - jpy
          - Jpy
          - JPY
          type: string
          x-versionadded: v2.41
        instanceType:
          description: Instance type where workload was executed
          type: string
          x-versionadded: v2.41
        price:
          description: Numeric price for workload
          type: number
          x-versionadded: v2.41
        priceUnit:
          description: The unit of price calculation.
          type: string
          x-versionadded: v2.41
        resourceBundleId:
          description: The identifier of the resource bundle
          type: string
        resourceBundleName:
          description: Human readable name of the resource bundle
          type: string
        usageUnit:
          description: The unit of measurement for the usage value
          type: string
        usageValue:
          description: Numeric measure of the usage
          type: number
        workloadId:
          description: The identifier of the workload
          type: string
        workloadName:
          description: Human readable name of the workload
          type: string
      required:
      - resourceBundleId
      - resourceBundleName
      - usageUnit
      - usageValue
      - workloadId
      - workloadName
      type: object
      x-versionadded: v2.35
    UsageResponse:
      properties:
        data:
          description: The usage records.
          items:
            $ref: '#/components/schemas/UsageItem'
          maxItems: 1000
          type: array
      required:
      - data
      type: object
      x-versionadded: v2.35
    UseCaseApplicationResponse:
      properties:
        applicationId:
          description: The ID of the application.
          type: string
        applicationTemplateType:
          description: The type of the application.
          type:
          - string
          - 'null'
        createdAt:
          description: The timestamp generated at application creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        description:
          description: The description of the application.
          type:
          - string
          - 'null'
        lastActivity:
          $ref: '#/components/schemas/UseCaseLastActivity'
        name:
          description: The name of the application.
          type: string
        projectId:
          description: The ID of the associated project.
          type:
          - string
          - 'null'
        source:
          description: The source used to create the application.
          type:
          - string
          - 'null'
        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
      x-versionadded: v2.45
    UseCaseCreate:
      properties:
        advancedTour:
          description: Advanced tour key.
          enum:
          - flightDelays
          - hospital
          type:
          - string
          - 'null'
        description:
          default: null
          description: The description of the Use Case.
          type:
          - string
          - 'null'
        name:
          default: null
          description: The name of the Use Case.
          maxLength: 100
          type:
          - string
          - 'null'
      type: object
    UseCaseCustomApplication:
      properties:
        applicationUrl:
          description: The reachable URL of the custom application.
          type: string
          x-versionadded: v2.35
        createdAt:
          description: The time when this model was created.
          format: date-time
          type: string
          x-versionadded: v2.35
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          x-versionadded: v2.35
        customApplicationSourceId:
          description: The ID of the custom application source.
          type:
          - string
          - 'null'
          x-versionadded: v2.39
        id:
          description: The ID of the custom application.
          type: string
        lastActivity:
          description: The type of the last activity. Can be "Added" or "Modified".
          enum:
          - created
          - Created
          - CREATED
          - modified
          - Modified
          - MODIFIED
          type: string
        name:
          description: The name of the custom application.
          type: string
        permissions:
          description: The list of permissions available for the user.
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.39
        status:
          description: The status of the custom application.
          type: string
          x-versionadded: v2.35
        updatedAt:
          description: The time when this activity occurred.
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        userHasAccess:
          description: Indicates if a user has access to this custom application.
          type: boolean
          x-versionadded: v2.35
      required:
      - id
      type: object
      x-versionadded: v2.35
    UseCaseCustomApplicationsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of custom applications.
          items:
            $ref: '#/components/schemas/UseCaseCustomApplication'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    UseCaseDataListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: The list of the datasets in this use case.
          items:
            $ref: '#/components/schemas/UseCaseDataResponse'
          type: array
          x-versionadded: v2.33
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
          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
          - native-databricks
          - bigquery-v1
          - bigquery1
          - bigquery2
          - athena2
          - athena1
          - kdb
          - treasuredata
          - elasticsearch
          - snowflake
          - mysql
          - mssql
          - postgres
          - palantirfoundry
          - teradata
          - redshift
          - datasphere-v1
          - trino-v1
          - salesforce-v1
          - native-gdrive
          - native-sharepoint
          - native-confluence
          - native-jira
          - native-box
          - native-onedrive
          - native-salesforce
          - unknown
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        dataType:
          description: The type of data entity.
          enum:
          - static
          - Static
          - STATIC
          - snapshot
          - Snapshot
          - SNAPSHOT
          - dynamic
          - Dynamic
          - DYNAMIC
          - sqlRecipe
          - SqlRecipe
          - SQL_RECIPE
          - 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
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        description:
          description: The description of the dataset or recipe.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        modifiedAt:
          description: The timestamp generated at dataset modification.
          format: date-time
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        name:
          description: The name of the dataset or recipe.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        processingState:
          description: The current ingestion process state of the dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type:
          - string
          - 'null'
          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
          type:
          - integer
          - 'null'
          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
          type:
          - integer
          - 'null'
        createdAt:
          description: The timestamp generated at dataset creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        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.
          type:
          - string
          - 'null'
        dataType:
          description: The type of data entity.
          enum:
          - static
          - Static
          - STATIC
          - snapshot
          - Snapshot
          - SNAPSHOT
          - dynamic
          - Dynamic
          - DYNAMIC
          - sqlRecipe
          - SqlRecipe
          - SQL_RECIPE
          - 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
          type:
          - integer
          - 'null'
        datasetSourceType:
          description: The source type of the dataset.
          type:
          - string
          - 'null'
        description:
          description: The description of the dataset.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        featureDiscoveryProjectId:
          description: Related feature discovery project if this is a feature discovery
            dataset.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        modifiedAt:
          description: The timestamp generated at dataset modification.
          format: date-time
          type: string
        modifiedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        name:
          description: The name of the dataset.
          type: string
        processingState:
          description: The current ingestion process state of the dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        referenceMetadata:
          $ref: '#/components/schemas/ExperimentContainerReferenceDatasetResponse'
        rowCount:
          description: The number of data rows in the dataset. ``null`` might be returned
            in case dataset is in running or errored state
          type:
          - integer
          - 'null'
        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: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseDetails:
      description: Details of the use-case associated to this registered model version
      properties:
        createdAt:
          description: The time when the use case was created.
          type: string
        creatorEmail:
          description: The email of the user who created the use case.
          type:
          - string
          - 'null'
        creatorId:
          description: The ID of the creator of the use case.
          type: string
        creatorName:
          description: The name of the user who created the use case.
          type:
          - string
          - 'null'
        id:
          description: The ID of the associated use case.
          type: string
        name:
          description: The name of the use case at the moment of creation.
          type:
          - string
          - 'null'
      required:
      - createdAt
      - creatorId
      - id
      type: object
    UseCaseEntityVersion:
      properties:
        createdAt:
          description: Time when this entity was created.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        id:
          description: The id of the entity version.
          type: string
        lastActivity:
          $ref: '#/components/schemas/ExperimentContainerLastActivity'
        name:
          description: The name of the entity version.
          type: string
        registeredModelVersion:
          description: The version number of the entity version.
          type: integer
        updatedAt:
          description: Time when the last update occurred.
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
      required:
      - createdAt
      - createdBy
      - id
      - lastActivity
      - name
      - registeredModelVersion
      - updatedAt
      - updatedBy
      type: object
      x-versionadded: v2.36
    UseCaseFileResponse:
      properties:
        createdAt:
          description: The timestamp generated at file creation.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        dataSourceType:
          description: The type of the data source used to create the file (if relevant).
          type:
          - string
          - 'null'
        description:
          description: The description of the file.
          type:
          - string
          - 'null'
        fileId:
          description: The file ID.
          type: string
        fileSourceType:
          description: The source type of the file.
          type:
          - string
          - 'null'
        modifiedAt:
          description: The timestamp generated at file modification.
          format: date-time
          type: string
        modifiedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        name:
          description: The name of the file.
          type: string
        numFiles:
          description: The number of files in catalog item. ``null`` might be returned
            in cases where the file is in a running or errored state.
          type:
          - integer
          - 'null'
        processingState:
          description: Current ingestion process state of file.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        referenceMetadata:
          $ref: '#/components/schemas/ExperimentContainerReferenceDatasetResponse'
        versionId:
          description: The file version ID for the file's latest version.
          type: string
      required:
      - createdAt
      - createdBy
      - dataSourceType
      - description
      - fileId
      - fileSourceType
      - modifiedAt
      - modifiedBy
      - name
      - numFiles
      - processingState
      - referenceMetadata
      - versionId
      type: object
      x-versionadded: v2.37
    UseCaseFilesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A list of the files in the Use Case.
          items:
            $ref: '#/components/schemas/UseCaseFileResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.37
    UseCaseIdName:
      description: The information of the use case associated with the project.
      properties:
        id:
          description: The ID of the use case.
          type:
          - string
          - 'null'
        name:
          description: The name of the use case.
          type:
          - string
          - 'null'
      type: object
      x-versionadded: v2.36
    UseCaseInfo:
      description: Information about the use case that this modeling project is attached
        to.
      properties:
        id:
          description: The ID of the use case this modeling project is attached to.
          type: string
        name:
          description: The name of the use case this modeling project is attached
            to.
          type: string
      required:
      - id
      - name
      type: object
    UseCaseLastActivity:
      description: The last activity details.
      properties:
        timestamp:
          description: The 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: The number of items returned on this page.
          type: integer
        data:
          description: The list of use cases that match the query.
          items:
            $ref: '#/components/schemas/UseCaseResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseListWithShortenedInfoResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: A list of Use Cases with shortened info that match the query
          items:
            $ref: '#/components/schemas/UseCaseWithShortenedInfoResponse'
          maxItems: 100
          minItems: 1
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.34
    UseCaseMemberResponse:
      properties:
        email:
          description: The email address of the member.
          type:
          - string
          - 'null'
        fullName:
          description: The full name of the member.
          type:
          - string
          - 'null'
        id:
          description: The ID of the member.
          type: string
        isGroup:
          description: Whether the member is a user group.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.45
        isOrganization:
          description: Whether the member is an organization.
          type:
          - boolean
          - 'null'
        userhash:
          description: The member's gravatar hash.
          type:
          - string
          - 'null'
        username:
          description: The username of the member.
          type:
          - string
          - 'null'
      required:
      - email
      - id
      type: object
    UseCaseModelsForComparisonListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseNotebookResponse:
      properties:
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        createdAt:
          description: The timestamp generated at notebook creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        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: The ID of the use case reference.
          type: string
        tenantId:
          description: The id of the tenant the notebook belongs to.
          type:
          - string
          - 'null'
        updatedBy:
          description: The ID of the user who last updated.
          type:
          - string
          - 'null'
        useCaseId:
          description: The ID of the linked use case.
          type: string
        useCaseName:
          description: The name of the linked use case.
          type: string
      required:
      - created
      - createdAt
      - entityId
      - entityType
      - experimentContainerId
      - id
      - isDeleted
      - referenceId
      - tenantId
      - useCaseId
      type: object
      x-versionadded: v2.45
    UseCasePlaygroundResponse:
      properties:
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        createdAt:
          description: The timestamp generated at playground creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        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 the database.
          type: string
        tenantId:
          description: The id of the tenant the playground belongs to.
          type:
          - string
          - 'null'
        updatedBy:
          description: The ID of the user who last updated.
          type:
          - string
          - 'null'
      required:
      - created
      - createdAt
      - entityId
      - entityType
      - id
      - isDeleted
      - referenceId
      - tenantId
      type: object
      x-versionadded: v2.46
    UseCaseProjectOptionsResponse:
      description: Project options currently saved for a project. Can be changed while
        project is in draft status.
      properties:
        target:
          description: Name of the target
          type:
          - string
          - 'null'
        targetType:
          description: The target type of the project.
          enum:
          - Binary
          - Regression
          - Multiclass
          - minInflated
          - Multilabel
          - TextGeneration
          - GeoPoint
          - VectorDatabase
          type:
          - string
          - 'null'
        validationType:
          description: The validation type of the partitioning strategy for the project,
            either CV for cross-validation or TVH for train-validation-holdout split.
          enum:
          - CV
          - TVH
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        weight:
          description: Name of the weight (if configured)
          type:
          - string
          - 'null'
      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
          type:
          - string
          - 'null'
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        createdAt:
          description: The timestamp generated at project creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        datasetVersionId:
          description: The dataset version ID of the dataset in the registry.
          type:
          - string
          - 'null'
          x-versionadded: v2.41
        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'
        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'
        stage:
          description: Stage of the experiment.
          type: string
          x-versionadded: v2.34
        statusErrorMessage:
          description: Experiment failure explanation.
          type: string
        target:
          description: Name of the target
          type:
          - string
          - 'null'
        targetType:
          description: The type of modeling target.
          enum:
          - Binary
          - Regression
          - Multiclass
          - minInflated
          - Multilabel
          - TextGeneration
          - GeoPoint
          - VectorDatabase
          type:
          - string
          - 'null'
        timeAware:
          description: Shows if project uses time series
          type: boolean
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        updatedAt:
          description: The timestamp generated at project modification.
          format: date-time
          type: string
        updatedBy:
          description: The ID of the user who last updated.
          type:
          - string
          - 'null'
      required:
      - autopilotDataSelectionMethod
      - created
      - createdAt
      - dataset
      - datasetId
      - datasetVersionId
      - hasHoldout
      - isDatasetLinkedToUseCase
      - isDraft
      - isErrored
      - isScoringAvailableForModelsTrainedIntoValidationHoldout
      - isWorkbenchEligible
      - lastActivity
      - metricDetail
      - models
      - name
      - numberOfBacktests
      - projectId
      - projectOptions
      - stage
      - statusErrorMessage
      - timeAware
      - updated
      - updatedAt
      type: object
    UseCaseProjectsListResponse:
      properties:
        count:
          description: The 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: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCaseRecentAssetsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
          x-versionadded: v2.33
        data:
          description: The list of the use case references that match the query.
          items:
            $ref: '#/components/schemas/UseCaseReferenceRetrieve'
          maxItems: 100
          type: array
          x-versionadded: v2.33
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
        datasetSize:
          description: The size of the dataset in bytes.
          type:
          - integer
          - 'null'
          x-versionadded: v2.34
        datasetSourceType:
          description: The source type of the dataset
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
      required:
      - dataSourceType
      - datasetSize
      - datasetSourceType
      - isSnapshot
      - isWranglingEligible
      - latestRecipeId
      type: object
    UseCaseReferenceFileMetadata:
      properties:
        dataSourceType:
          description: The data source type used to create the file if relevant.
          type:
          - string
          - 'null'
        fileSourceType:
          description: The source type of the file.
          type:
          - string
          - 'null'
        numFiles:
          description: The number of files in the catalog item.
          type:
          - integer
          - 'null'
      required:
      - dataSourceType
      - fileSourceType
      - numFiles
      type: object
      x-versionadded: v2.37
    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: The number of items returned on this page.
          type: integer
        data:
          description: The list of the use case references that match the query.
          items:
            $ref: '#/components/schemas/UseCaseReferenceRetrieve'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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
          - file
          - notebook
          - application
          - recipe
          - syftrSearchInstance
          - customModelVersion
          - registeredModelVersion
          - deployment
          - customApplication
          - customJob
          - embeddingModelValidation
          type: string
          x-versionadded: v2.33
        includeDataset:
          default: true
          description: Include dataset migration when an experiment is migrated
          type: boolean
          x-versionadded: v2.34
      required:
      - entityId
      - entityType
      type: object
    UseCaseReferencePlaygroundMetadata:
      properties:
        description:
          description: The description of the playground.
          type: string
        playgroundType:
          description: The type of the playground.
          type: string
          x-versionadded: v2.37
      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
        stage:
          description: Stage of the experiment.
          type: string
          x-versionadded: v2.34
        statusErrorMessage:
          description: The experiment failure explanation.
          type: string
      required:
      - isDraft
      - isErrored
      - isWorkbenchEligible
      - stage
      - 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
          - sqlRecipe
          - SqlRecipe
          - SQL_RECIPE
          - wranglingRecipe
          - WranglingRecipe
          - WRANGLING_RECIPE
          - featureDiscoveryRecipe
          - FeatureDiscoveryRecipe
          - FEATURE_DISCOVERY_RECIPE
          type:
          - string
          - 'null'
      required:
      - dataType
      type: object
    UseCaseReferenceRetrieve:
      properties:
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        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'
        metadata:
          description: The reference metadata for the use case.
          oneOf:
          - $ref: '#/components/schemas/UseCaseReferenceProjectMetadata'
          - $ref: '#/components/schemas/UseCaseReferenceDatasetMetadata'
          - $ref: '#/components/schemas/UseCaseReferenceRecipeMetadata'
          - $ref: '#/components/schemas/UseCaseReferencePlaygroundMetadata'
          - $ref: '#/components/schemas/UseCaseReferenceVectorDatabasesMetadata'
          - $ref: '#/components/schemas/UseCaseReferenceFileMetadata'
        name:
          description: The name of the Use Case reference.
          type: string
        processingState:
          description: The current ingestion process state of the dataset.
          enum:
          - COMPLETED
          - ERROR
          - RUNNING
          type: string
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        updatedAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        updatedBy:
          description: The ID of the user who last updated.
          type:
          - string
          - 'null'
        useCaseId:
          description: The ID of the linked use case.
          type: string
        useCaseName:
          description: The name of the linked use case.
          type:
          - string
          - 'null'
        userHasAccess:
          description: Identifies if a user has access to the entity.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.36
        versions:
          description: The list of entity versions.
          items:
            $ref: '#/components/schemas/UseCaseEntityVersion'
          maxItems: 100
          type: array
          x-versionadded: v2.36
      required:
      - entityId
      - entityType
      - id
      - name
      - updatedAt
      - useCaseId
      type: object
    UseCaseReferenceVectorDatabasesMetadata:
      properties:
        errorMessage:
          description: The error message, if any, for the vector database.
          type:
          - string
          - 'null'
          x-versionadded: v2.38
        source:
          description: The source of the vector database
          type: string
      required:
      - errorMessage
      - source
      type: object
      x-versionadded: v2.37
    UseCaseRegisteredModel:
      properties:
        createdAt:
          description: The time when this model was created.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        id:
          description: The ID of the registered model.
          type: string
        lastActivity:
          $ref: '#/components/schemas/UseCaseRegisteredModelLastActivity'
        name:
          description: The name of the registered model.
          type: string
        updatedAt:
          description: The time when this activity occurred.
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        userHasAccess:
          description: Indicates if a user has access to this registered model.
          type: boolean
          x-versionadded: v2.35
        versions:
          description: The list of registered model versions.
          items:
            $ref: '#/components/schemas/UseCaseRegisteredModelVersion'
          maxItems: 100
          type: array
      required:
      - id
      - userHasAccess
      type: object
      x-versionadded: v2.35
    UseCaseRegisteredModelLastActivity:
      description: The last activity details.
      properties:
        timestamp:
          description: The 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
      x-versionadded: v2.36
    UseCaseRegisteredModelVersion:
      properties:
        createdAt:
          description: The time when this model was created.
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        id:
          description: The ID of the registered model version.
          type: string
        lastActivity:
          $ref: '#/components/schemas/UseCaseRegisteredModelLastActivity'
        name:
          description: The name of the registered model version.
          type: string
        registeredModelVersion:
          description: The version number of the registered model version.
          type: integer
          x-versionadded: v2.35
        updatedAt:
          description: The time when the last update occurred.
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
      required:
      - createdAt
      - createdBy
      - id
      - lastActivity
      - name
      - registeredModelVersion
      - updatedAt
      - updatedBy
      type: object
      x-versionadded: v2.35
    UseCaseRegisteredModelsResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of registered models.
          items:
            $ref: '#/components/schemas/UseCaseRegisteredModel'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.35
    UseCaseResponse:
      properties:
        advancedTour:
          description: Advanced tour key.
          type:
          - string
          - 'null'
        applicationsCount:
          description: The number of applications in a Use Case.
          type: integer
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        createdAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created.
          type:
          - string
          - 'null'
        customApplicationsCount:
          description: The number of custom applications referenced in a Use Case.
          type: integer
          x-versionadded: v2.35
        customJobsCount:
          description: The number of custom jobs referenced in a Use Case.
          type: integer
          x-versionadded: v2.35
        customModelVersionsCount:
          description: The number of custom models referenced in a Use Case.
          type: integer
          x-versionadded: v2.35
        datasetsCount:
          description: The number of datasets in a Use Case.
          type: integer
        deploymentsCount:
          description: The number of deployments referenced in a Use Case.
          type: integer
          x-versionadded: v2.35
        description:
          description: The description of the Use Case.
          type:
          - string
          - 'null'
        filesCount:
          description: The number of files in a Use Case.
          type: integer
          x-versionadded: v2.37
        formattedDescription:
          description: The formatted description of the experiment container used
            as styled description.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the Use Case.
          type: string
        members:
          description: The list of use case members.
          items:
            $ref: '#/components/schemas/UseCaseMemberResponse'
          type: array
        modelsCount:
          description: '[DEPRECATED] The number of models in a Use Case.'
          type: integer
          x-versiondeprecated: v2.34
        name:
          description: The name of the Use Case.
          type: string
        notebooksCount:
          description: The number of notebooks in a Use Case.
          type: integer
        owners:
          description: The list of owners of a use case.
          items:
            $ref: '#/components/schemas/UseCaseMemberResponse'
          type: array
        primaryRiskAssessment:
          $ref: '#/components/schemas/RiskAssessmentComplete'
          x-versionadded: v2.36
        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
        registeredModelVersionsCount:
          description: The number of registered models referenced in a Use Case.
          type: integer
          x-versionadded: v2.35
        riskAssessments:
          description: The ID List of the Risk Assessments.
          items:
            type: string
          maxItems: 100
          type: array
          x-versionadded: v2.36
        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.
          type:
          - string
          - 'null'
        updated:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        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.
          type:
          - string
          - 'null'
        valueTracker:
          $ref: '#/components/schemas/ValueTrackerResponse'
          x-versionadded: v2.36
        valueTrackerId:
          description: The ID of the Value Tracker.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
      required:
      - applicationsCount
      - created
      - createdAt
      - customApplicationsCount
      - customJobsCount
      - customModelVersionsCount
      - datasetsCount
      - deploymentsCount
      - description
      - filesCount
      - id
      - members
      - name
      - notebooksCount
      - projectsCount
      - recipesCount
      - registeredModelVersionsCount
      - role
      - tenantId
      - updated
      - updatedAt
      type: object
    UseCaseSharedRolesUpdate:
      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/UseCaseSharingRoleUpdateDataWithUsername'
            - $ref: '#/components/schemas/UseCaseSharingRoleUpdateDataWithName'
            - $ref: '#/components/schemas/UseCaseSharingRoleUpdateDataWithId'
          minItems: 1
          type: array
      required:
      - operation
      - roles
      type: object
      x-versionadded: v2.46
    UseCaseSharingRoleUpdateDataWithId:
      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
          - group
          - organization
          type: string
      required:
      - id
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.46
    UseCaseSharingRoleUpdateDataWithName:
      properties:
        name:
          description: The name of the user to update the access role for. If included
            with a username, the username is used.
          type: string
        role:
          description: The assigned role.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type.
          enum:
          - user
          type: string
      required:
      - name
      - role
      - shareRecipientType
      type: object
      x-versionadded: v2.46
    UseCaseSharingRoleUpdateDataWithUsername:
      properties:
        role:
          description: The assigned role.
          enum:
          - OWNER
          - EDITOR
          - CONSUMER
          - NO_ROLE
          type: string
        shareRecipientType:
          description: The recipient type.
          enum:
          - user
          type: string
        username:
          description: The username of the user to update the access role for. If
            included with a name, the username is used.
          type: string
      required:
      - role
      - shareRecipientType
      - username
      type: object
      x-versionadded: v2.46
    UseCaseUpdate:
      properties:
        description:
          description: The description of the Use Case.
          type:
          - string
          - 'null'
        name:
          description: The name of the Use Case.
          maxLength: 100
          type:
          - string
          - 'null'
      type: object
    UseCaseVectorDatabaseRelatedCustomModel:
      properties:
        createdAt:
          description: The time that this custom model version was created.
          format: date-time
          type: string
        createdBy:
          description: The username of the user who created this custom model version.
          type: string
        customModelId:
          description: The ID of this custom model.
          type: string
        customModelVersionId:
          description: The ID of this version of this custom model.
          type: string
        name:
          description: The name of the custom model created from this vector database.
          type: string
        role:
          description: The role that the requesting user has on this custom model
            version
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type:
          - string
          - 'null'
        versionMajor:
          description: The major version number of this custom model version.
          type: integer
        versionMinor:
          description: The minor version number of this custom model version.
          type: integer
      required:
      - createdAt
      - createdBy
      - customModelId
      - customModelVersionId
      - name
      - role
      - versionMajor
      - versionMinor
      type: object
      x-versionadded: v2.36
    UseCaseVectorDatabaseRelatedCustomModelList:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of custom model versions created from this vector
            database.
          items:
            $ref: '#/components/schemas/UseCaseVectorDatabaseRelatedCustomModel'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.36
    UseCaseVectorDatabaseRelatedDeployment:
      properties:
        createdAt:
          description: The time that this deployment was created.
          format: date-time
          type: string
        createdBy:
          description: The username of the user who created this deployment.
          type: string
        customModelId:
          description: ID of the custom model currently deployed to this deployment
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        customModelVersionId:
          description: ID of the custom model version currently deployed to this deployment
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        id:
          description: The ID of the deployment with this vector database deployed.
          type: string
        name:
          description: The name of the deployment with this vector database deployed.
          type: string
        registeredModelId:
          description: ID of the registered model currently deployed to this deployment
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        registeredModelVersionId:
          description: ID of the registered model version currently deployed to this
            deployment
          type:
          - string
          - 'null'
          x-versionadded: v2.37
        role:
          description: The role that the requesting user has on this deployment
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type:
          - string
          - 'null'
      required:
      - createdAt
      - createdBy
      - id
      - name
      - role
      type: object
      x-versionadded: v2.36
    UseCaseVectorDatabaseRelatedDeploymentList:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of deployments that this vector database is currently
            deployed on.
          items:
            $ref: '#/components/schemas/UseCaseVectorDatabaseRelatedDeployment'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.36
    UseCaseVectorDatabaseRelatedRegisteredModel:
      properties:
        createdAt:
          description: The time that this registered model version was created.
          format: date-time
          type: string
        createdBy:
          description: The username of the user who created this registered model
            version.
          type: string
        registeredModelId:
          description: The ID of this registered model.
          type: string
        registeredModelName:
          description: The name of the registered model created from this vector database.
          type: string
        registeredModelVersionId:
          description: The ID of this version of this registered model.
          type: string
        registeredModelVersionName:
          description: The name of the registered model version created from this
            vector database.
          type: string
        role:
          description: The role that the requesting user has on this registered model
            version
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type:
          - string
          - 'null'
        version:
          description: The version number of this registered model version.
          type: integer
      required:
      - createdAt
      - createdBy
      - registeredModelId
      - registeredModelName
      - registeredModelVersionId
      - registeredModelVersionName
      - role
      - version
      type: object
      x-versionadded: v2.36
    UseCaseVectorDatabaseRelatedRegisteredModelList:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of registered model versions created from this vector
            database.
          items:
            $ref: '#/components/schemas/UseCaseVectorDatabaseRelatedRegisteredModel'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.36
    UseCaseVectorDatabaseResponse:
      properties:
        created:
          $ref: '#/components/schemas/ExperimentContainerUserResponse'
        createdAt:
          description: The timestamp generated at vector database creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created the vector database.
          type:
          - string
          - 'null'
        entityId:
          description: The primary ID of the entity (this is the same as the ID of
            the vector database).
          type: string
        entityType:
          description: The type of entity, vector database, identified by the entity
            ID.
          enum:
          - vector_database
          type: string
        id:
          description: The ID of the vector database.
          type: string
        isDeleted:
          description: Sets whether vector databases are removed from the Use Case
            (soft deletion) but not from the repository.
          type: boolean
        referenceId:
          description: The creation ID of the vector database as opposed to the ID
            used by the Use Case to identify the vector database.
          type: string
        tenantId:
          description: The ID of the tenant that the vector database belongs to.
          type:
          - string
          - 'null'
        updatedBy:
          description: The ID of the user who last updated the vector database.
          type:
          - string
          - 'null'
      required:
      - created
      - createdAt
      - entityId
      - entityType
      - id
      - isDeleted
      - referenceId
      - tenantId
      type: object
      x-versionadded: v2.46
    UseCaseWithShortenedInfoResponse:
      properties:
        advancedTour:
          description: Advanced tour key.
          type:
          - string
          - 'null'
        createdAt:
          description: The timestamp generated at record creation.
          format: date-time
          type: string
        createdBy:
          description: The ID of the user who created the Use Case.
          type:
          - string
          - 'null'
        description:
          description: The description of the Use Case.
          type:
          - string
          - 'null'
        formattedDescription:
          description: The formatted description of the experiment container used
            as styled description.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
        id:
          description: The ID of the Use Case.
          type: string
        name:
          description: The name of the Use Case.
          type: string
        tenantId:
          description: The ID of the tenant to associate this organization with.
          type:
          - string
          - 'null'
        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 the Use Case.
          type:
          - string
          - 'null'
        valueTrackerId:
          description: The ID of the Value Tracker.
          type:
          - string
          - 'null'
          x-versionadded: v2.36
      required:
      - createdAt
      - description
      - formattedDescription
      - id
      - name
      - tenantId
      - updatedAt
      type: object
      x-versionadded: v2.34
    UseCasesApplicationsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of the applications in this Use Case.
          items:
            $ref: '#/components/schemas/UseCaseApplicationResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCasesNotebooksListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of the notebooks in this use case.
          items:
            $ref: '#/components/schemas/UseCaseNotebookResponse'
          maxItems: 100
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCasesPlaygroundsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of the playgrounds in this Use Case.
          items:
            $ref: '#/components/schemas/UseCasePlaygroundResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UseCasesProjectMigrationParam:
      properties:
        includeDataset:
          default: true
          description: Include dataset migration when project is migrated.
          type: boolean
      type: object
      x-versionadded: v2.34
    UseCasesVectorDatabasesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of vector databases in this Use Case.
          items:
            $ref: '#/components/schemas/UseCaseVectorDatabaseResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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: The 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'
        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.
          maxLength: 1000
          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.
          type:
          - string
          - 'null'
        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.
          maxLength: 1000
          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.
          maxLength: 1000
          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.
          type:
          - string
          - 'null'
        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: The number of items returned on this page.
          type: integer
        data:
          description: The list of SharedRoles objects.
          items:
            $ref: '#/components/schemas/UserBlueprintSharedRolesResponse'
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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 \u2014 one of user, group, organization,\
            \ or externalApplication."
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
    UserBlueprintTask:
      properties:
        arguments:
          description: The 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'
          type: array
        customTaskId:
          description: The ID of the custom task, if it is a custom task.
          type:
          - string
          - 'null'
        customTaskVersions:
          description: Metadata for all of the custom task's versions.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskCustomTaskMetadataWithArguments'
          type: array
        description:
          description: The 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.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            type: array
          - type: 'null'
        name:
          description: The name of the argument.
          type: string
        recommended:
          description: The recommended value, based on frequently used values.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            type: array
          - type: 'null'
        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,
            a list, or a dictionary of ranges or lists keyed by type.
          oneOf:
          - anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: number
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            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: The list of the available task category items.
          items:
            $ref: '#/components/schemas/AllowExtra'
          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.
          type:
          - string
          - 'null'
        taskCode:
          description: The task code representing the task to validate parameter values.
          type: string
        taskParameters:
          description: The 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
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            type: array
        paramName:
          description: The name of the task parameter to be validated.
          type: string
      required:
      - newValue
      - paramName
      type: object
    UserBlueprintTasksResponse:
      properties:
        categories:
          description: The list of the available task categories, sub-categories,
            and tasks.
          items:
            $ref: '#/components/schemas/UserBlueprintTaskCategoryItem'
          type: array
        tasks:
          description: The 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'
        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.
          maxLength: 1000
          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.
          type:
          - string
          - 'null'
        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'
        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.
          type:
          - string
          - 'null'
      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.
          type:
          - string
          - 'null'
        taskParameters:
          default: []
          description: The parameters which further define the behavior of the task.
          items:
            $ref: '#/components/schemas/ParamValuePair'
          type: array
        xTransformations:
          default: []
          description: The transformations to apply to the input data before fitting
            or predicting.
          items:
            $ref: '#/components/schemas/ParamValuePair'
          type: array
        yTransformations:
          default: []
          description: The 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: The 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: The 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: The 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'
        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: The list of the names of tasks used in the blueprint.
          items:
            type: string
          type: array
        featuresText:
          description: The description of the blueprint via the names of tasks used.
          type: string
        hexColumnNameLookup:
          description: The 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.
          type:
          - string
          - 'null'
        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: The list of associated pairs of an input type 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: The list of the names of tasks used in the blueprint.
          items:
            type: string
          type: array
        featuresText:
          description: The description of the blueprint via the names of tasks used.
          type: string
        hexColumnNameLookup:
          description: The 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.
          type:
          - string
          - 'null'
        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: The number of records on this page.
          type: integer
        data:
          description: The list of user blueprints.
          items:
            $ref: '#/components/schemas/UserBlueprintsListItem'
          maxItems: 100
          type: array
        next:
          description: The URL to the next page, or `null` if there is no such page.
          type:
          - string
          - 'null'
        previous:
          description: The URL to the previous page, or `null` if there is no such
            page.
          type:
          - string
          - 'null'
        totalCount:
          description: The 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'
        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: The list of the names of tasks used in the blueprint.
          items:
            type: string
          type: array
        featuresText:
          description: The description of the blueprint via the names of tasks used.
          type: string
        hexColumnNameLookup:
          description: The 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.
          type:
          - string
          - 'null'
        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
            - type: 'null'
          - items:
              anyOf:
              - type: string
              - type: integer
              - type: boolean
              - type: number
              - type: 'null'
            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'
          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
          - 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'
          maxItems: 50
          type: array
      required:
      - count
      - data
      type: object
    UserBulkCreateResponseData:
      description: Response message/data from this specific User creation request
      properties:
        message:
          description: Error or other response message from the creation request if
            present.
          type: string
        notifyStatus:
          $ref: '#/components/schemas/NotifyStatus'
        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'
        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'
          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
          - 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'
        userId:
          description: The ID of the user.
          type: string
        username:
          description: The username of the user.
          type: string
      required:
      - userId
      - username
      type: object
    UserData:
      additionalProperties: false
      description: User information embedded in API responses.
      properties:
        email:
          anyOf:
          - type: string
          - type: 'null'
          description: User email address
          title: Email
        fullName:
          anyOf:
          - type: string
          - type: 'null'
          description: User's full name
          title: Full Name
        id:
          description: User ID associated with this resource
          title: User ID
          type: string
        userhash:
          anyOf:
          - type: string
          - type: 'null'
          description: User's gravatar hash
          title: Userhash
        username:
          anyOf:
          - type: string
          - type: 'null'
          description: Username
          title: Username
      required:
      - id
      title: UserData
      type: object
    UserFeatureFlags:
      description: User feature flags.
      properties:
        DISABLE_CODESPACE_SCHEDULING:
          description: Whether codespace scheduling is disabled for the user.
          title: Disable Codespace Scheduling
          type: boolean
        DISABLE_DUMMY_FEATURE_FLAG_FOR_TESTING:
          description: Dummy feature flag used for testing.
          title: Disable Dummy Feature Flag For Testing
          type: boolean
        DISABLE_NOTEBOOKS_CODESPACES:
          description: Whether codespaces are disabled for the user.
          title: Disable Notebooks Codespaces
          type: boolean
        DISABLE_NOTEBOOKS_SCHEDULING:
          description: Whether scheduling is disabled for the user.
          title: Disable Notebooks Scheduling
          type: boolean
        DISABLE_NOTEBOOKS_SESSION_PORT_FORWARDING:
          default: false
          description: Whether session port forwarding is disabled for the user.
          title: Disable Notebooks Session Port Forwarding
          type: boolean
        ENABLE_DUMMY_FEATURE_FLAG_FOR_TESTING:
          description: Dummy feature flag used for testing.
          title: Enable Dummy Feature Flag For Testing
          type: boolean
        ENABLE_MMM_HOSTED_CUSTOM_METRICS:
          description: Whether custom metrics are enabled for the user.
          title: Enable Mmm Hosted Custom Metrics
          type: boolean
        ENABLE_NOTEBOOKS:
          description: Whether notebooks are enabled for the user.
          title: Enable Notebooks
          type: boolean
        ENABLE_NOTEBOOKS_CUSTOM_ENVIRONMENTS:
          default: true
          description: Whether custom environments are enabled for the user.
          title: Enable Notebooks Custom Environments
          type: boolean
        ENABLE_NOTEBOOKS_FILESYSTEM_MANAGEMENT:
          description: Whether filesystem management is enabled for the user.
          title: Enable Notebooks Filesystem Management
          type: boolean
        ENABLE_NOTEBOOKS_GPU:
          description: Whether GPU is enabled for the user.
          title: Enable Notebooks Gpu
          type: boolean
        ENABLE_NOTEBOOKS_OPEN_AI:
          description: Whether OpenAI is enabled for the user.
          title: Enable Notebooks Open Ai
          type: boolean
        ENABLE_NOTEBOOKS_SESSION_PORT_FORWARDING:
          default: true
          description: Whether session port forwarding is enabled for the user.
          title: Enable Notebooks Session Port Forwarding
          type: boolean
        ENABLE_NOTEBOOKS_TERMINAL:
          description: Whether terminals are enabled for the user.
          title: Enable Notebooks Terminal
          type: boolean
      title: UserFeatureFlags
      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.
          type:
          - string
          - 'null'
        accessRoleName:
          description: The name of the access role assigned to the group.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        description:
          description: The description of this user group.
          type:
          - string
          - 'null'
        email:
          description: The email of this user group.
          type:
          - string
          - 'null'
        externalId:
          description: The identifier of this group in the identity provider. Set
            when the group is managed via SCIM.
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        id:
          description: The identifier of the user group.
          type: string
        maxCustomDeployments:
          description: The number of maximum custom deployments available for users
            of this group.
          type:
          - integer
          - 'null'
        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.
          type:
          - integer
          - 'null'
        maxEdaWorkers:
          description: The upper limit for a number of EDA workers to be run for users
            of this user group.
          type:
          - integer
          - 'null'
        maxRam:
          description: The upper limit for amount of RAM available to users of this
            user group.
          type:
          - integer
          - 'null'
        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.
          type:
          - integer
          - 'null'
        maxUploadSize:
          description: The maximum allowed upload size for users of this group.
          type:
          - integer
          - 'null'
        maxUploadSizeCatalog:
          description: The maximum allowed upload size in the AI catalog for users
            in this group.
          type:
          - integer
          - 'null'
        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.
          type:
          - integer
          - 'null'
        maxWorkers:
          description: The upper limit for a number of workers to be run for users
            of this user group.
          type:
          - integer
          - 'null'
        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.
          type:
          - string
          - 'null'
        orgName:
          description: The name of the organization this user group belongs to.
          type:
          - string
          - 'null'
        scimIdpName:
          description: The name of the identity provider managing this group via SCIM,
            e.g. `okta` or `entra_id`.
          type:
          - string
          - 'null'
          x-versionadded: v2.44
        scimManaged:
          description: Set to `true` if this group is managed by an external identity
            provider via SCIM. Set to `false` if not.
          type: boolean
          x-versionadded: v2.44
      required:
      - accessRoleId
      - accessRoleName
      - accountPermissions
      - createdBy
      - description
      - email
      - externalId
      - id
      - maxCustomDeployments
      - maxCustomDeploymentsLimit
      - maxEdaWorkers
      - maxRam
      - maxUploadCatalogSizeLimit
      - maxUploadSize
      - maxUploadSizeCatalog
      - maxUploadSizeLimit
      - maxWorkers
      - membersCount
      - name
      - orgId
      - orgName
      - scimIdpName
      - scimManaged
      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.
          type:
          - string
          - 'null'
        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'
          maxItems: 100
          type: array
        next:
          description: The URL to the next page.
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL to the previous page.
          format: uri
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        firstName:
          description: The first name of the user.
          type:
          - string
          - 'null'
        lastName:
          description: The last name of the user.
          type:
          - string
          - 'null'
        organization:
          description: The name of the organization the user is part of.
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
        userId:
          description: The identifier of the user.
          type:
          - string
          - 'null'
        username:
          description: The name of the user.
          type: string
      required:
      - firstName
      - lastName
      - organization
      - status
      - userId
      - username
      type: object
    UserInfo:
      description: User information.
      properties:
        activated:
          default: true
          description: Whether the user is activated.
          title: Activated
          type: boolean
        firstName:
          description: The first name of the user.
          title: Firstname
          type: string
          x-versionadded: v2.45
        gravatarHash:
          description: The gravatar hash of the user.
          title: Gravatarhash
          type: string
        id:
          description: The ID of the user.
          title: Id
          type: string
        lastName:
          description: The last name of the user.
          title: Lastname
          type: string
          x-versionadded: v2.45
        orgId:
          description: The ID of the organization the user belongs to.
          title: Orgid
          type: string
        tenantPhase:
          description: The tenant phase of the user.
          title: Tenantphase
          type: string
        userId:
          description: ID of the User.
          type: string
        username:
          description: The username of the user.
          title: Username
          type: string
      required:
      - id
      title: UserInfo
      type: object
    UserListResponse:
      properties:
        count:
          description: Number of users in this page.
          type: integer
        data:
          description: List of user objects.
          items:
            $ref: '#/components/schemas/UserRetrieveResponse'
          maxItems: 50
          type: array
        next:
          description: URL pointing to the next page of results.
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page of results.
          type:
          - string
          - 'null'
        totalCount:
          description: Total number of users matching the query.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
      x-versionadded: v2.46
    UserMCPServerDeploymentPromptCreationPayload:
      properties:
        name:
          description: MCP prompt name
          maxLength: 256
          type: string
        type:
          description: Supported MCP prompt types
          enum:
          - userPromptTemplate
          - userPromptTemplateVersion
          type: string
      required:
      - name
      - type
      type: object
      x-versionadded: v2.46
    UserMCPServerDeploymentPromptsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of MCP prompts
          items:
            $ref: '#/components/schemas/MCPServerDeploymentPrompt'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.46
    UserMCPServerDeploymentResourceCreationPayload:
      properties:
        name:
          description: MCP resource name
          maxLength: 256
          type: string
        type:
          description: Supported MCP resource types
          enum:
          - userResource
          type: string
        uri:
          description: MCP resource URI
          type: string
      required:
      - name
      - type
      - uri
      type: object
      x-versionadded: v2.46
    UserMCPServerDeploymentResourcesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of MCP resources
          items:
            $ref: '#/components/schemas/MCPServerDeploymentResource'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.46
    UserMCPServerDeploymentToolCreationPayload:
      properties:
        name:
          description: MCP tool name
          maxLength: 256
          type: string
        type:
          description: Supported MCP tool types
          enum:
          - userTool
          - builtInTool
          - userToolDeployment
          type: string
      required:
      - name
      - type
      type: object
      x-versionadded: v2.46
    UserMCPServerDeploymentToolsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: List of MCP tools
          items:
            $ref: '#/components/schemas/MCPServerDeploymentTool'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.46
    UserMCPServerVersionPromptsCreationPayload:
      properties:
        name:
          description: The MCP prompt name.
          maxLength: 256
          type: string
        type:
          description: Supported MCP onboard prompt types
          enum:
          - userPromptTemplate
          type: string
      required:
      - name
      - type
      type: object
      x-versionadded: v2.46
    UserMCPServerVersionPromptsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of MCP prompts.
          items:
            $ref: '#/components/schemas/MCPServerVersionPrompt'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.46
    UserMCPServerVersionResourcesCreationPayload:
      properties:
        name:
          description: The MCP resource name.
          maxLength: 256
          type: string
        type:
          description: Supported MCP onboard resource types
          enum:
          - userResource
          type: string
        uri:
          description: The MCP resource URI.
          type: string
      required:
      - name
      - type
      - uri
      type: object
      x-versionadded: v2.46
    UserMCPServerVersionResourcesListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of MCP resources.
          items:
            $ref: '#/components/schemas/MCPServerVersionResource'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.46
    UserMCPServerVersionToolsCreationPayload:
      properties:
        name:
          description: The MCP tool name.
          maxLength: 256
          type: string
        type:
          description: Supported MCP onboard tool types
          enum:
          - userTool
          - builtInTool
          type: string
      required:
      - name
      - type
      type: object
      x-versionadded: v2.46
    UserMCPServerVersionToolsListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of MCP tools.
          items:
            $ref: '#/components/schemas/MCPServerVersionTool'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
      required:
      - data
      - next
      - previous
      type: object
      x-versionadded: v2.46
    UserMetadata:
      description: Information on the user who last modified the registered model
      properties:
        email:
          description: The email of the user.
          type:
          - string
          - 'null'
        id:
          description: The ID of the user.
          type: string
        name:
          description: The full name of the user.
          type:
          - string
          - 'null'
      required:
      - email
      - id
      - name
      type: object
    UserNotificationListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of the user's notifications.
          items:
            $ref: '#/components/schemas/UserNotificationResponse'
          maxItems: 1000
          type: array
        next:
          description: The URL of the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: The URL of the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items across all pages.
          type: integer
      required:
      - data
      - next
      - previous
      - totalCount
      type: object
    UserNotificationRelatedCommentResponse:
      description: Details about the comment related to the notification.
      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
          - experimentContainer
          - deployment
          - workload
          type: string
        inactive:
          description: True if the comment was deleted.
          type: boolean
      required:
      - commentId
      - entityId
      type: object
    UserNotificationRelatedDeploymentResponse:
      description: Details about the deployment related to the notification.
      properties:
        deploymentId:
          description: The ID of the deployment.
          type: string
        deploymentName:
          description: The deployment label.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        projectId:
          description: The ID of the related project.
          type:
          - string
          - 'null'
        userId:
          description: The ID of the related user.
          type:
          - string
          - 'null'
      required:
      - deploymentId
      type: object
    UserNotificationRelatedProjectResponse:
      description: Details about the project related to the notification.
      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: The project name.
          type:
          - string
          - 'null'
      required:
      - pid
      type: object
    UserNotificationRelatedSecureConfigResponse:
      description: Details about the secure config related to the notification.
      properties:
        secureConfigLink:
          description: The link to the secure config.
          type: string
        secureConfigName:
          description: The name of the secure config.
          type: string
        secureConfigSchemaName:
          description: The type UUID of the secure config.
          type: string
        secureConfigSchemaUuid:
          description: The type name of the secure config.
          type: string
        secureConfigUuid:
          description: The ID of the secure config.
          type: string
      required:
      - secureConfigLink
      - secureConfigName
      - secureConfigSchemaName
      - secureConfigSchemaUuid
      - secureConfigUuid
      type: object
    UserNotificationRelatedUserResponse:
      description: Details about the user who triggered the notification.
      properties:
        fullName:
          description: User's full name.
          type:
          - string
          - 'null'
        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: The username of the user.
          type: string
      required:
      - uid
      type: object
    UserNotificationRelatedUsersDeleteResponse:
      description: Details about the users permanent delete.
      properties:
        reportId:
          description: The ID of the user's permanent delete report.
          type: string
        statusId:
          description: The ID of the user's delete status.
          type: string
        usersToDeleteCount:
          description: The number of users that will be deleted.
          type: string
      required:
      - reportId
      - statusId
      - usersToDeleteCount
      type: object
    UserNotificationResponse:
      properties:
        callerUser:
          $ref: '#/components/schemas/UserNotificationRelatedUserResponse'
        created:
          description: The ISO 8601 formatted date and time when the notification
            was created.
          format: date-time
          type: string
        data:
          description: Notification type-specific metadata.
          oneOf:
          - $ref: '#/components/schemas/InviteJobNotificationData'
          - type: 'null'
          x-versionadded: v2.39
        description:
          description: The notification description.
          type:
          - string
          - 'null'
        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
          - misc.asset_access_request
          - users_delete.preview_started
          - users_delete.preview_completed
          - users_delete.preview_failed
          - perma_delete_project.failure
          - perma_delete_project.success
          - secure_config.shared
          - entity_notification_policy_template.shared
          - notification_channel_template.shared
          - invite_job.completed
          - scim.user_provision_failed
          - scim.group_provision_failed
          type: string
        isRead:
          description: True if the notification is already read.
          type: boolean
        link:
          description: The 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'
        relatedDeployment:
          $ref: '#/components/schemas/UserNotificationRelatedDeploymentResponse'
        relatedProject:
          $ref: '#/components/schemas/UserNotificationRelatedProjectResponse'
        relatedSecureConfig:
          $ref: '#/components/schemas/UserNotificationRelatedSecureConfigResponse'
        relatedUsersDelete:
          $ref: '#/components/schemas/UserNotificationRelatedUsersDeleteResponse'
        sharedUsers:
          description: The list of the user details a resource was shared with.
          items:
            $ref: '#/components/schemas/UserNotificationRelatedUserResponse'
          type: array
        statusId:
          description: The asynchronous job status ID.
          type: string
        title:
          description: The notification title.
          type:
          - string
          - 'null'
        tooltip:
          description: The notification tooltip.
          type:
          - string
          - 'null'
        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:
      description: A set operations the user can or can not make with the Change Request.
      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
    UserRetrieveResponse:
      properties:
        accessRoleIds:
          description: Access role IDs assigned to the user.
          items:
            type: string
          maxItems: 1000
          type: array
        activated:
          description: Whether the user account is activated.
          type: boolean
        attributionId:
          description: User ID in external marketing systems.
          type:
          - string
          - 'null'
        company:
          description: The user's company.
          type:
          - string
          - 'null'
        country:
          description: The user's country.
          type:
          - string
          - 'null'
        createdByServiceUserId:
          description: ID of the service user that created this user.
          type:
          - string
          - 'null'
        defaultCatalogDatasetSampleSize:
          $ref: '#/components/schemas/AdminSampleSize'
        expirationDate:
          description: When the user account expires.
          format: date-time
          type:
          - string
          - 'null'
        firstName:
          description: The user's first name.
          type:
          - string
          - 'null'
        id:
          description: The ID of the user.
          type: string
        industry:
          description: The user's industry.
          type:
          - string
          - 'null'
        inviteCode:
          description: The user's invite code.
          type:
          - string
          - 'null'
        invitedById:
          description: The ID of the user who invited this user.
          type:
          - string
          - 'null'
        isOrgAdmin:
          description: Whether the user is an organization admin.
          type: boolean
        jobTitle:
          description: The user's job title.
          type:
          - string
          - 'null'
        language:
          description: The user's preferred language.
          type:
          - string
          - 'null'
        lastLoginDate:
          description: The user's last login date.
          format: date-time
          type:
          - string
          - 'null'
        lastName:
          description: The user's last name.
          type:
          - string
          - 'null'
        lifecycle:
          description: The lifecycle state of the user.
          type: string
        marketingOptIn:
          description: Whether the user opted in to marketing emails.
          type:
          - boolean
          - 'null'
        maxConcurrentWorkloads:
          description: The maximum number of concurrently running workloads allowed.
            A value of zero means unlimited.
          type: integer
          x-versionadded: v2.46
        maxEdaWorkers:
          description: Maximum number of EDA workers.
          type: integer
        maxGpuWorkers:
          description: Maximum number of GPU workers.
          type: integer
        maxIdleWorkers:
          description: Maximum number of idle workers.
          type: integer
        maxRam:
          description: Maximum RAM allocation in bytes.
          type:
          - integer
          - 'null'
        maxUploadSize:
          description: Maximum upload size in bytes.
          type: integer
        maxUploadSizeCatalog:
          description: Maximum upload size for AI catalog in bytes.
          type: integer
        maxWorkers:
          description: Maximum number of modeling workers.
          type: integer
        maxWorkloadReplicas:
          description: The maximum number of replicas per workload allowed. A value
            of zero means unlimited.
          type: integer
          x-versionadded: v2.46
        multiFactorAuthEnabled:
          description: Whether multi-factor authentication is enabled.
          type: boolean
        organizationId:
          description: The ID of the organization the user belongs to.
          type:
          - string
          - 'null'
        permissions:
          additionalProperties:
            type: boolean
          description: Account permissions for the user.
          type: object
        phone:
          description: The user's phone number.
          type:
          - string
          - 'null'
        registeredOn:
          description: When the user registered.
          format: date-time
          type:
          - string
          - 'null'
        roles:
          additionalProperties:
            type: string
          description: A mapping of project IDs to the user's role on each project.
          type: object
        scheduledForDeletion:
          description: Whether the user is scheduled for permanent deletion.
          type: boolean
        scimIdpName:
          description: Name of the identity provider managing this user via SCIM (e.g.,
            'Okta', 'entra_id'). Null for non-SCIM-managed users.
          type:
          - string
          - 'null'
          x-versionadded: v2.46
        scimManaged:
          description: True when this user is provisioned and managed by an external
            identity provider via SCIM. SCIM-managed users have IdP-owned attributes
            that are read-only in DataRobot.
          type: boolean
          x-versionadded: v2.46
        state:
          description: The user's US state.
          type:
          - string
          - 'null'
        tenantId:
          description: The tenant ID for this user.
          type:
          - string
          - 'null'
        updatedAt:
          description: When the user record was last updated.
          format: date-time
          type:
          - string
          - 'null'
        updatedBy:
          description: The ID of the user who last updated this record.
          type:
          - string
          - 'null'
        userType:
          description: The user's account type classification.
          type: string
        username:
          description: The email address of the user.
          type: string
      required:
      - accessRoleIds
      - activated
      - attributionId
      - company
      - country
      - createdByServiceUserId
      - firstName
      - id
      - industry
      - inviteCode
      - invitedById
      - isOrgAdmin
      - jobTitle
      - language
      - lastLoginDate
      - lastName
      - lifecycle
      - marketingOptIn
      - maxConcurrentWorkloads
      - maxEdaWorkers
      - maxGpuWorkers
      - maxRam
      - maxUploadSize
      - maxUploadSizeCatalog
      - maxWorkers
      - maxWorkloadReplicas
      - organizationId
      - permissions
      - phone
      - registeredOn
      - roles
      - state
      - tenantId
      - updatedAt
      - updatedBy
      - userType
      - username
      type: object
      x-versionadded: v2.46
    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
          type:
          - string
          - 'null'
        username:
          description: The 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:
        forceDeploymentDelete:
          default: false
          description: If true, any deployment this user group has a role on, including
            those shared outside the users, will be deleted.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        forceNoCodeApplicationDelete:
          default: false
          description: If true, any no code app this user group has a role on, including
            those shared outside the users, will be deleted.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        forceProjectDelete:
          default: false
          description: If true, any project this user group has a role on, including
            those shared outside the users, will be deleted.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        orgId:
          default: null
          description: Organization which's users to be permanently deleted.
          type:
          - string
          - 'null'
        orphansOwner:
          default: null
          description: User which becomes an owner of any projects or deployments
            that otherwise cause an error because they would be orphaned.
          type:
          - string
          - 'null'
        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'
        message:
          description: May contain further details.
          type:
          - string
          - 'null'
      required:
      - data
      - message
      type: object
    UsersPermadeleteJobResponse:
      properties:
        message:
          description: Information about the users perma-deletion job submission.
          type:
          - string
          - 'null'
      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'
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
      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'
        message:
          description: May contain further information about the status.
          type:
          - string
          - 'null'
        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:
      description: The users cleanup report statistics.
      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'
        message:
          description: May contain further details.
          type:
          - string
          - 'null'
      required:
      - data
      - message
      type: object
    UsersPermadeleteResponse:
      description: The users cleanup delete parameters.
      properties:
        forceDeploymentDelete:
          default: false
          description: If true, any deployment this user group has a role on, including
            those shared outside the users, will be deleted.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        forceNoCodeApplicationDelete:
          default: false
          description: If true, any no code app this user group has a role on, including
            those shared outside the users, will be deleted.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        forceProjectDelete:
          default: false
          description: If true, any project this user group has a role on, including
            those shared outside the users, will be deleted.
          type:
          - boolean
          - 'null'
          x-versionadded: v2.37
        orgId:
          default: null
          description: Organization which's users to be permanently deleted.
          type:
          - string
          - 'null'
        orphansOwner:
          default: null
          description: User which becomes an owner of any projects or deployments
            that otherwise cause an error because they would be orphaned.
          type:
          - string
          - 'null'
        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:
      description: The users cleanup summary report statistics.
      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'
        message:
          description: May contain further details.
          type:
          - string
          - 'null'
      required:
      - data
      - message
      type: object
    VCSCommandStatus:
      description: Status of the VCS command.
      enum:
      - not_inited
      - running
      - finished
      - error
      title: VCSCommandStatus
      type: string
    ValidationCheck:
      description: Whether the replacement model has the same target name as the current
        model.
      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:
      description: A more granular explanation of why the replacement model was eligible
        or ineligible.
      properties:
        combinedModelSegments:
          $ref: '#/components/schemas/ValidationCheck'
        containsTrackedSegmentAttributes:
          $ref: '#/components/schemas/ValidationCheck'
        driftTracking:
          $ref: '#/components/schemas/ValidationCheck'
          x-versionadded: v2.29
        featureDataTypes:
          $ref: '#/components/schemas/ValidationCheck'
        features:
          $ref: '#/components/schemas/ValidationCheck'
        humilityRules:
          $ref: '#/components/schemas/ValidationCheck'
        modelCanBeDeployed:
          $ref: '#/components/schemas/ValidationCheck'
        modelStatus:
          $ref: '#/components/schemas/ValidationCheck'
        notCurrentModel:
          $ref: '#/components/schemas/ValidationCheck'
        permission:
          $ref: '#/components/schemas/ValidationCheck'
        predictionIntervals:
          $ref: '#/components/schemas/ValidationCheck'
        predictionReady:
          $ref: '#/components/schemas/ValidationCheck'
        seriesType:
          $ref: '#/components/schemas/ValidationCheck'
        supported:
          $ref: '#/components/schemas/ValidationCheck'
        target:
          $ref: '#/components/schemas/ValidationCheck'
        targetClasses:
          $ref: '#/components/schemas/ValidationCheck'
        targetType:
          $ref: '#/components/schemas/ValidationCheck'
        timeSeriesCompatibility:
          $ref: '#/components/schemas/ValidationCheck'
        validChallenger:
          $ref: '#/components/schemas/ValidationCheck'
      type: object
    ValidationError:
      properties:
        ctx:
          description: Additional context about the validation error.
          title: Context
          type: object
        input:
          additionalProperties: true
          description: The input value that caused the validation error.
          title: Input
          type: object
        loc:
          description: The location in the request where the validation error occurred.
          items:
            anyOf:
            - type: string
            - type: integer
          maxItems: 100
          title: loc
          type: array
        msg:
          description: A human-readable description of the validation error.
          title: msg
          type: string
        type:
          description: A machine-readable error type identifier.
          title: type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    ValueField:
      description: A custom metric value source when reading values from columnar
        dataset like a file.
      properties:
        columnName:
          description: Column name
          type:
          - string
          - 'null'
      required:
      - columnName
      type: object
    ValueTracker:
      properties:
        businessImpact:
          description: The expected effects on overall business operations.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        commentId:
          description: The ID for this comment.
          type: string
        content:
          description: A string
          type: string
        description:
          description: The value tracker description.
          maxLength: 1024
          type: string
        feasibility:
          description: Assessment of how the value tracker can be accomplished across
            multiple dimensions.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        id:
          description: The ID of this description item.
          type:
          - string
          - 'null'
        mentions:
          description: The list of user objects.
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        name:
          description: The name of the value tracker.
          maxLength: 512
          type: string
        notes:
          description: The user notes.
          type:
          - string
          - 'null'
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
        permissions:
          description: The permissions of the current user.
          items:
            type: string
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          - type: 'null'
          description: Optional. Contains the template type and parameter information.
        predictionTargets:
          description: An array of prediction target name strings.
          items:
            description: The name of the prediction target
            type: string
          type: array
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          - type: 'null'
          description: Optional. Contains MonetaryValue objects.
        stage:
          description: The current stage of the value tracker.
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: The array of TargetDate objects.
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          type: array
      required:
      - name
      type: object
    ValueTrackerActivity:
      description: DataRobot user information.
      properties:
        eventDescription:
          $ref: '#/components/schemas/ValueTrackerEventDescriptions'
        eventType:
          description: The type of activity.
          type:
          - string
          - 'null'
        firstName:
          description: The first name of the ValueTracker owner.
          type:
          - string
          - 'null'
        id:
          description: The ID of the ValueTracker activity.
          type: string
        lastName:
          description: The last name of the ValueTracker owner.
          type:
          - string
          - 'null'
        timestamp:
          description: The timestamp of the activity.
          format: date-time
          type: string
        user:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
        username:
          description: The username of the 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 the value tracker.
          items:
            $ref: '#/components/schemas/ValueTrackerActivity'
          type: array
        next:
          description: URL pointing to the next page (if null, there is no next page).
          format: uri
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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: The value tracker attachment type.
          enum:
          - dataset
          - modelingProject
          - deployment
          - customModel
          - modelPackage
          - application
          type: string
      required:
      - attachedObjectId
      - type
      type: object
    ValueTrackerAttachmentApplicationOverview:
      properties:
        appType:
          description: The type of the application.
          type: string
        createdAt:
          description: The time when the application was created.
          format: date-time
          type: string
        lastModifiedAt:
          description: The time of the last modification.
          format: date-time
          type: string
        name:
          description: The name of the application.
          type: string
        version:
          description: The version string of the app.
          type: string
      required:
      - appType
      - createdAt
      - lastModifiedAt
      - name
      - version
      type: object
    ValueTrackerAttachmentCustomModelOverview:
      properties:
        createdAt:
          description: The time when the custom model was created.
          format: date-time
          type: string
        modifiedAt:
          description: The time of the last modification.
          format: date-time
          type: string
        name:
          description: The name of the custom model.
          type: string
        owner:
          description: The name of the custom model owner.
          type: string
      required:
      - createdAt
      - modifiedAt
      - name
      - owner
      type: object
    ValueTrackerAttachmentDatasetOverview:
      properties:
        createdAt:
          description: The time when the dataset was created.
          format: date-time
          type: string
        createdBy:
          description: The name of the user who created the dataset.
          type: string
        lastModifiedAt:
          description: The time of the last modification.
          format: date-time
          type: string
        lastModifiedBy:
          description: The name of the user who did the last modification.
          type: string
        name:
          description: The name of the dataset.
          type: string
      required:
      - createdAt
      - createdBy
      - lastModifiedAt
      - lastModifiedBy
      - name
      type: object
    ValueTrackerAttachmentDeploymentHealth:
      description: Accuracy related health status.
      properties:
        endDate:
          description: The end date of the health status.
          format: date-time
          type: string
        message:
          description: Health status related information.
          type: string
        startDate:
          description: The start date of the 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'
        modelHealth:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentHealth'
        name:
          description: The name of the deployment.
          type: string
        predictionServer:
          description: The name of the prediction server.
          type: string
        predictionUsage:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentPredictionUsage'
        serviceHealth:
          $ref: '#/components/schemas/ValueTrackerAttachmentDeploymentHealth'
      required:
      - accuracyHealth
      - modelHealth
      - name
      - predictionServer
      - predictionUsage
      - serviceHealth
      type: object
    ValueTrackerAttachmentDeploymentPredictionUsage:
      description: The value tracker attachment detail for deployment usage.
      properties:
        dailyRates:
          description: The 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: The number of results returned.
          type: integer
        data:
          description: The array of attachment objects.
          items:
            $ref: '#/components/schemas/ValueTrackerAttachmentResponse'
          type: array
        next:
          description: The link to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The link to the previous page.
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of results available.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ValueTrackerAttachmentModelPackageOverview:
      properties:
        createdAt:
          description: The time when the model package was created.
          format: date-time
          type: string
        deploymentCount:
          description: The number of deployments.
          type: integer
        executionType:
          description: The type of execution.
          type: string
        name:
          description: The name of the model package.
          type: string
        targetName:
          description: The name of the 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: The time when the project was created.
          format: date-time
          type: string
        datasetName:
          description: The name of the default dataset.
          type: string
        name:
          description: The name of the project.
          type: string
        numberOfModels:
          description: The number of models in the project.
          type:
          - integer
          - 'null'
        owner:
          description: The name of the modeling project owner.
          type:
          - string
          - 'null'
        targetName:
          description: The name of the modeling target.
          type: string
        useCase:
          $ref: '#/components/schemas/UseCaseInfo'
          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 the user has view access to the attached object.
          type: boolean
        id:
          description: The ID of the ValueTracker.
          type: string
        isAccessRequested:
          description: Indicates if the user has requested access to the attached
            object.
          type: boolean
        overview:
          description: Detailed information depending on the type of the attachment
          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: 'null'
        type:
          description: The value tracker attachment type.
          enum:
          - dataset
          - modelingProject
          - deployment
          - customModel
          - modelPackage
          - application
          type: string
        useCaseId:
          description: The ID of the ValueTracker.
          type: string
      required:
      - attachedObjectId
      - canView
      - id
      - isAccessRequested
      - overview
      - type
      - useCaseId
      type: object
    ValueTrackerBucket:
      properties:
        period:
          $ref: '#/components/schemas/ValueTrackerBucketPeriod'
        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:
      description: A `period` object describing the time this bucket covers
      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:
      description: The value tracker information.
      properties:
        accuracyHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          - type: 'null'
          description: The health of the accuracy.
        businessImpact:
          description: The expected effects on overall business operations.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        commentId:
          description: The ID for this comment.
          type: string
        content:
          description: A string
          type: string
        description:
          description: The value tracker description.
          type: string
        feasibility:
          description: Assessment of how the value tracker can be accomplished across
            multiple dimensions.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        id:
          description: The ID of the ValueTracker.
          type: string
        inProductionWarning:
          description: An optional warning to indicate that deployments are attached
            to this value tracker.
          type:
          - string
          - 'null'
        mentions:
          description: The list of user objects.
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        modelHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          - type: 'null'
          description: The health of the model.
        name:
          description: The name of the value tracker.
          type: string
        notes:
          description: The user notes.
          type:
          - string
          - 'null'
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
        permissions:
          description: The permissions of the current user.
          items:
            type: string
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          - type: 'null'
          description: Optional. Contains the template type and parameter information.
        predictionTargets:
          description: An array of prediction target name strings.
          items:
            description: The name of the prediction target
            type: string
          type: array
        predictionsCount:
          anyOf:
          - type: string
          - type: integer
          - description: The list of prediction counts.
            items:
              type: integer
            type: array
          description: The count of the number of predictions made.
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          - type: 'null'
          description: Optional. Contains MonetaryValue objects.
        serviceHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          - type: 'null'
          description: The health of the service.
        stage:
          description: The current stage of the value tracker.
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: The array of TargetDate objects.
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          type: array
      type: object
    ValueTrackerDrUserId:
      description: DataRobot user information.
      properties:
        firstName:
          description: The first name of the ValueTracker owner.
          type:
          - string
          - 'null'
        id:
          description: The DataRobot user ID.
          type: string
        lastName:
          description: The last name of the ValueTracker owner.
          type:
          - string
          - 'null'
        username:
          description: The username of the ValueTracker owner.
          type: string
      required:
      - id
      type: object
    ValueTrackerEventDescriptions:
      description: Details of the activity. Content depends on activity type.
      properties:
        businessImpact:
          description: The expected effects on overall business operations.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        commentId:
          description: The ID for this comment.
          type: string
        content:
          description: A string
          type: string
        description:
          description: The value tracker description.
          type:
          - string
          - 'null'
        feasibility:
          description: Assessment of how the value tracker can be accomplished across
            multiple dimensions.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        id:
          description: The ID of this description item.
          type:
          - string
          - 'null'
        mentions:
          description: The list of user objects.
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        name:
          description: The name of this event item.
          type:
          - string
          - 'null'
        notes:
          description: The user notes.
          type:
          - string
          - 'null'
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
        permissions:
          description: The permissions of the current user.
          items:
            type: string
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          - type: 'null'
          description: Optional. Contains the template type and parameter information.
        predictionTargets:
          description: An array of prediction target name strings.
          items:
            description: The name of the prediction target
            type: string
          type: array
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          - type: 'null'
          description: Optional. Contains MonetaryValue objects.
        stage:
          description: The current stage of the value tracker.
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: The array of TargetDate objects.
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          type: array
      type: object
    ValueTrackerHealthInformation:
      properties:
        endDate:
          description: The end date for this health status.
          format: date-time
          type:
          - string
          - 'null'
        message:
          description: Information about the health status.
          type:
          - string
          - 'null'
        startDate:
          description: The start date for this health status.
          format: date-time
          type:
          - string
          - 'null'
        status:
          description: The status of the value tracker.
          type:
          - string
          - 'null'
      required:
      - endDate
      - message
      - startDate
      - status
      type: object
    ValueTrackerListResponse:
      properties:
        count:
          description: The number of items returned on this page.
          type: integer
        data:
          description: The list of value trackers 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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        totalCount:
          description: The number of items matching the query condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    ValueTrackerMonetaryValue:
      description: Optional. Contains MonetaryValue objects.
      properties:
        currency:
          description: The ISO code of the currency.
          enum:
          - AED
          - BRL
          - CHF
          - EUR
          - GBP
          - JPY
          - KRW
          - UAH
          - USD
          - ZAR
          type: string
        details:
          description: Optional user notes.
          type:
          - string
          - 'null'
        value:
          description: The 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'
        summary:
          $ref: '#/components/schemas/ValueTrackerSummary'
      required:
      - buckets
      - previousTimeRangeSummary
      - summary
      type: object
    ValueTrackerResponse:
      description: The value tracker information.
      properties:
        accuracyHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          - type: 'null'
          description: The health of the accuracy.
        businessImpact:
          description: The expected effects on overall business operations.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        commentId:
          description: The ID for this comment.
          type: string
        content:
          description: A string
          type: string
        description:
          description: The value tracker description.
          type:
          - string
          - 'null'
        feasibility:
          description: Assessment of how the value tracker can be accomplished across
            multiple dimensions.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        id:
          description: The ID of the ValueTracker.
          type: string
        inProductionWarning:
          description: An optional warning to indicate that deployments are attached
            to this value tracker.
          type:
          - string
          - 'null'
        mentions:
          description: The list of user objects.
          items:
            $ref: '#/components/schemas/ValueTrackerDrUserId'
          type: array
        modelHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          - type: 'null'
          description: The health of the model.
        name:
          description: The name of the value tracker.
          type: string
        notes:
          description: The user notes.
          type:
          - string
          - 'null'
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
        permissions:
          description: The permissions of the current user.
          items:
            type: string
          type: array
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          - type: 'null'
          description: Optional. Contains the template type and parameter information.
        predictionTargets:
          description: An array of prediction target name strings.
          items:
            description: The name of the prediction target
            type: string
          type: array
        predictionsCount:
          anyOf:
          - type: string
          - type: integer
          - description: The list of prediction counts.
            items:
              type: integer
            type: array
          description: The count of the number of predictions made.
        realizedValue:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerMonetaryValue'
          - type: 'null'
          description: Optional. Contains MonetaryValue objects.
        serviceHealth:
          anyOf:
          - type: string
          - $ref: '#/components/schemas/ValueTrackerHealthInformation'
          - type: 'null'
          description: The health of the service.
        stage:
          description: The current stage of the value tracker.
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: The array of TargetDate objects.
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          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
          type:
          - string
          - 'null'
        previous:
          description: URL pointing to the previous page (if null, there is no previous
            page).
          format: uri
          type:
          - string
          - 'null'
        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:
      description: A `summary` object covering the time range before the given one
        with the same duration
      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'
        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: The date of the target.
          format: date-time
          type: string
        stage:
          description: The name of the target stage.
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
      required:
      - date
      - stage
      type: object
    ValueTrackerUpdate:
      properties:
        businessImpact:
          description: The expected effects on overall business operations.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        description:
          description: The value tracker description.
          maxLength: 1024
          type:
          - string
          - 'null'
        feasibility:
          description: Assessment of how the value tracker can be accomplished across
            multiple dimensions.
          maximum: 5
          minimum: 1
          type:
          - integer
          - 'null'
        name:
          description: The name of the value tracker.
          maxLength: 512
          type: string
        notes:
          description: The user notes.
          maxLength: 1024
          type:
          - string
          - 'null'
        owner:
          $ref: '#/components/schemas/ValueTrackerDrUserId'
        potentialValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
        potentialValueTemplate:
          anyOf:
          - $ref: '#/components/schemas/ValueTrackerValueTemplateClassification'
          - $ref: '#/components/schemas/ValueTrackerValueTemplateRegression'
          - type: 'null'
          description: Contains the template type and parameter information defined
            in the response of :http:get:`/api/v2/valueTrackerValueTemplates/(templateType)/calculation/`.
        predictionTargets:
          description: An array of prediction target name strings.
          items:
            type: string
          type: array
        realizedValue:
          $ref: '#/components/schemas/ValueTrackerMonetaryValue'
        stage:
          description: The current stage of the value tracker.
          enum:
          - ideation
          - queued
          - dataPrepAndModeling
          - validatingAndDeploying
          - inProduction
          - retired
          - onHold
          type: string
        targetDates:
          description: The array of TargetDate objects.
          items:
            $ref: '#/components/schemas/ValueTrackerTargetDate'
          type: array
      type: object
    ValueTrackerValueCalculateTemplate:
      description: Template type and data used for calculating the result
      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'
      required:
      - averageValuePerDecision
      - savedAnnually
      - template
      type: object
    ValueTrackerValueTemplateClassification:
      properties:
        data:
          $ref: '#/components/schemas/ValueTrackerValueTemplateClassificationData'
        templateType:
          description: The value tracker value template type.
          enum:
          - classification
          type: string
      required:
      - data
      - templateType
      type: object
    ValueTrackerValueTemplateClassificationData:
      description: The value tracker value data.
      properties:
        accuracyImprovement:
          description: Accuracy improvement.
          type: number
        decisionsCount:
          description: The estimated number of decisions per year.
          type: integer
        incorrectDecisionCost:
          description: The estimated cost of an individual incorrect decision.
          type: number
        incorrectDecisionsCount:
          description: The 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'
      required:
      - parameterName
      - schema
      type: object
    ValueTrackerValueTemplateRegression:
      properties:
        data:
          $ref: '#/components/schemas/ValueTrackerValueTemplateRegressionData'
        templateType:
          description: The value tracker value template type.
          enum:
          - regression
          type: string
      required:
      - data
      - templateType
      type: object
    ValueTrackerValueTemplateRegressionData:
      description: The value tracker value data.
      properties:
        accuracyImprovement:
          description: Accuracy improvement.
          type: number
        decisionsCount:
          description: The estimated number of decisions per year.
          type: integer
        targetValue:
          description: The target value.
          type: number
      required:
      - accuracyImprovement
      - decisionsCount
      - targetValue
      type: object
    ValueTrackerValueTemplateResponse:
      properties:
        description:
          description: The description of the 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: The title of the value template.
          type: string
      required:
      - description
      - schema
      - templateType
      - title
      type: object
    ValueTrackerValueTemplateSchema:
      description: Schema entry defining the type and limits of a template parameter
      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
          type:
          - integer
          - 'null'
        minimum:
          description: Sets Minimum value if given
          type:
          - integer
          - 'null'
        placeholder:
          description: Text that can be used to prefill an input filed for the value
          type: string
        unit:
          description: The unit type (e.g., %).
          type:
          - string
          - 'null'
      required:
      - elementType
      - label
      - maximum
      - minimum
      - placeholder
      - unit
      type: object
    Variable:
      description: Variable used in prompt template version.
      properties:
        description:
          description: Description of the variable. This is exposed to MCP clients.
          title: description
          type: string
        name:
          description: Name of the variable.
          title: name
          type: string
        type:
          default: str
          description: Type of the variable.
          title: type
          type: string
      required:
      - name
      - description
      title: Variable
      type: object
    VectorDatabaseConfig:
      description: Settings of the vector database.
      properties:
        addNeighborChunks:
          description: Add neighboring chunks to those that the similarity search
            retrieves.
          items:
            type: boolean
          title: addNeighborChunks
          type: array
        maxDocumentRetrievedPerPromptMax:
          default: 10
          description: Max value for the max number of chunks to retrieve from the
            vector database.
          title: maxDocumentRetrievedPerPromptMax
          type: integer
        maxDocumentRetrievedPerPromptMin:
          default: 1
          description: Min value for the max number of chunks to retrieve from the
            vector database.
          title: maxDocumentRetrievedPerPromptMin
          type: integer
        maxDocumentRetrievedPerPromptStep:
          default: 1
          description: Step for the max number of chunks to retrieve from the vector
            database.
          title: maxDocumentRetrievedPerPromptStep
          type: integer
        maxMmrLambdaMax:
          default: 1.0
          description: Maximum value of MMR lambda.
          title: maxMmrLambdaMax
          type: number
        maxMmrLambdaMin:
          default: 0.0
          description: Minimum value of MMR lambda.
          title: maxMmrLambdaMin
          type: number
        maxMmrLambdaStep:
          default: 0.1
          description: Step value of MMR lambda.
          title: maxMmrLambdaStep
          type: number
        retrievalModes:
          description: List of retriever modes to use.
          items:
            type: string
          title: retrievalModes
          type: array
        retrievers:
          description: List of retriever types to use.
          items:
            type: string
          title: retrievers
          type: array
      required:
      - retrievers
      - retrievalModes
      title: VectorDatabaseConfig
      type: object
    VectorDatabaseDeploymentStatuses:
      description: Sort order values for listing vector databases.
      enum:
      - Created
      - Assembling
      - Registered
      - Deployed
      title: VectorDatabaseDeploymentStatuses
      type: string
    VectorDatabaseExportResponse:
      description: API response object for exporting a vector database.
      properties:
        exportDatasetId:
          description: The Data Registry dataset ID.
          title: exportDatasetId
          type: string
        jobId:
          description: The ID of the export job.
          format: uuid4
          title: jobId
          type: string
        vectorDatabaseId:
          description: The ID of the vector database.
          title: vectorDatabaseId
          type: string
      required:
      - jobId
      - exportDatasetId
      - vectorDatabaseId
      title: VectorDatabaseExportResponse
      type: object
    VectorDatabaseResponse:
      description: API response object for a single vector database.
      properties:
        addedDatasetIds:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The list of dataset IDs that were added to the vector database
            in addition to the initial creation dataset.
          title: addedDatasetIds
        addedDatasetNames:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The list of dataset names that were added to the vector database
            in addition to the initial creation dataset.
          title: addedDatasetNames
        addedMetadataDatasetPairs:
          anyOf:
          - items:
              $ref: '#/components/schemas/MetadataDatasetPairApiFormatted'
            type: array
          - type: 'null'
          description: Pairs of metadata dataset and dataset added to the vector database.
          title: addedMetadataDatasetPairs
        chunkOverlapPercentage:
          anyOf:
          - type: integer
          - type: 'null'
          description: The chunk overlap percentage that the vector database uses.
          title: chunkOverlapPercentage
        chunkSize:
          anyOf:
          - type: integer
          - type: 'null'
          description: The size of the text chunk (measured in tokens) that the vector
            database uses.
          title: chunkSize
        chunkingLengthFunction:
          anyOf:
          - $ref: '#/components/schemas/ChunkingLengthFunctionNames'
          - type: 'null'
          default: approximate_token_count
          description: The length function to use for the text splitter.
        chunkingMethod:
          anyOf:
          - $ref: '#/components/schemas/ChunkingMethodNames'
          - type: 'null'
          description: The text chunking method the vector database uses.
        chunksCount:
          description: The number of text chunks in the vector database.
          title: chunksCount
          type: integer
        creationDate:
          description: The creation date of the vector database (ISO 8601 formatted).
          format: date-time
          title: creationDate
          type: string
        creationDuration:
          anyOf:
          - type: number
          - type: 'null'
          description: The duration of the vector database creation.
          title: creationDuration
        creationUserId:
          description: The ID of the user that created this vector database.
          title: creationUserId
          type: string
        customChunking:
          description: Whether the vector database uses custom chunking.
          title: customChunking
          type: boolean
        datasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the dataset the vector database was built from.
          title: datasetId
        datasetName:
          description: The name of the dataset this vector database was built from.
          title: datasetName
          type: string
        deploymentStatus:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseDeploymentStatuses'
          - type: 'null'
          description: How far along in the deployment process this vector database
            is.
        embeddingModel:
          anyOf:
          - $ref: '#/components/schemas/EmbeddingModelNames'
          - type: string
          - type: 'null'
          description: The name of the embedding model the vector database uses.
          title: embeddingModel
        embeddingRegisteredModelId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of registered model (in case of using NIM registered
            model for embeddings).
          title: embeddingRegisteredModelId
        embeddingValidationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The validation ID of the custom model embedding (in case of
            using a custom model for embeddings).
          title: embeddingValidationId
        errorMessage:
          anyOf:
          - type: string
          - type: 'null'
          description: The error message associated with the vector database creation
            error (in case of a creation error).
          title: errorMessage
        errorResolution:
          anyOf:
          - type: string
          - type: 'null'
          description: The suggested error resolution for the vector database creation
            error (in case of a creation error).
          title: errorResolution
        executionStatus:
          $ref: '#/components/schemas/ExecutionStatus'
          description: The creation status of the vector database.
        externalVectorDatabaseConnection:
          anyOf:
          - discriminator:
              mapping:
                elasticsearch: '#/components/schemas/ElasticsearchConnection'
                milvus: '#/components/schemas/MilvusConnection'
                pinecone: '#/components/schemas/PineconeConnection'
                postgres: '#/components/schemas/PostgresConnection'
              propertyName: type
            oneOf:
            - $ref: '#/components/schemas/PineconeConnection'
            - $ref: '#/components/schemas/ElasticsearchConnection'
            - $ref: '#/components/schemas/MilvusConnection'
            - $ref: '#/components/schemas/PostgresConnection'
          - type: 'null'
          description: The external vector database connection to use.
          title: externalVectorDatabaseConnection
        familyId:
          anyOf:
          - type: string
          - type: 'null'
          description: An ID associated with a family of vector databases, that is,
            a parent and all descendant vector databases. All vector databases that
            are descendants of the same root parent share a family ID.The family ID
            is equal to the vector database ID of the root parent.Like this each vector
            database knows it's direct parent and the root parent.
          title: familyId
        id:
          description: The ID of the vector database.
          title: id
          type: string
        isSeparatorRegex:
          description: Whether the text chunking separator uses a regular expression.
          title: isSeparatorRegex
          type: boolean
        lastUpdateDate:
          description: The date of the most recent update of this playground (ISO
            8601 formatted).
          format: date-time
          title: lastUpdateDate
          type: string
        metadataColumns:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The list of metadata columns in the vector database.
          title: metadataColumns
        metadataDatasetId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the dataset used to add metadata to the vector database.
          title: metadataDatasetId
        metadataDatasetName:
          anyOf:
          - type: string
          - type: 'null'
          description: The name of the dataset used to add metadata to the vector
            database.
          title: metadataDatasetName
        name:
          description: The name of the vector database.
          title: name
          type: string
        organizationId:
          description: The ID of the DataRobot organization this vector database belongs
            to.
          title: organizationId
          type: string
        parentId:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the direct parent vector database.It is generated
            when a vector database is created from another vector database.For the
            root (parent), ID is 'None'.
          title: parentId
        percentage:
          anyOf:
          - type: number
          - type: 'null'
          description: Vector database progress percentage.
          title: percentage
        playgroundsCount:
          description: The number of playgrounds that use this vector database.
          title: playgroundsCount
          type: integer
        separators:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          description: The text chunking separators that the vector database uses.
          title: separators
        size:
          description: The size of the vector database (in bytes).
          title: size
          type: integer
        skippedChunksCount:
          description: The number of text chunks skipped during vector database creation.
          title: skippedChunksCount
          type: integer
        source:
          $ref: '#/components/schemas/VectorDatabaseSource'
        tenantId:
          description: The ID of the DataRobot tenant this vector database belongs
            to.
          format: uuid4
          title: tenantId
          type: string
        useCaseId:
          description: The ID of the use case the vector database is linked to.
          title: useCaseId
          type: string
        userName:
          description: The name of the user that created this vector database.
          title: userName
          type: string
        validationId:
          anyOf:
          - type: string
          - type: 'null'
          description: The validation ID of the custom model vector database (in case
            of using a custom model vector database).
          title: validationId
        version:
          description: The version of the vector database linked to a certain family
            ID.
          title: version
          type: integer
      required:
      - id
      - name
      - size
      - useCaseId
      - datasetId
      - embeddingModel
      - embeddingValidationId
      - embeddingRegisteredModelId
      - chunkSize
      - chunkingMethod
      - chunkOverlapPercentage
      - chunksCount
      - skippedChunksCount
      - customChunking
      - separators
      - isSeparatorRegex
      - creationDate
      - creationUserId
      - organizationId
      - tenantId
      - lastUpdateDate
      - executionStatus
      - errorMessage
      - errorResolution
      - source
      - validationId
      - parentId
      - familyId
      - addedDatasetIds
      - version
      - playgroundsCount
      - datasetName
      - userName
      - addedDatasetNames
      title: VectorDatabaseResponse
      type: object
    VectorDatabaseRetrievers:
      description: The method used to retrieve relevant chunks from the vector database.
      enum:
      - SINGLE_LOOKUP_RETRIEVER
      - CONVERSATIONAL_RETRIEVER
      - MULTI_STEP_RETRIEVER
      title: VectorDatabaseRetrievers
      type: string
    VectorDatabaseSettingParameter:
      description: API response object for a single vector database setting parameter.
      properties:
        default:
          description: The default value of the parameter.
          title: default
        description:
          description: The description of the parameter.
          title: description
          type: string
        enum:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The list of possible values for the parameter.
          title: enum
        groupId:
          anyOf:
          - type: string
          - type: 'null'
          description: The identifier of the group the parameter belongs to.
          title: groupId
        maximum:
          anyOf:
          - type: integer
          - type: 'null'
          description: The maximum value of the parameter.
          title: maximum
        minimum:
          anyOf:
          - type: integer
          - type: 'null'
          description: The minimum value of the parameter.
          title: minimum
        name:
          description: The name of the parameter.
          title: name
          type: string
        settings:
          anyOf:
          - items:
              $ref: '#/components/schemas/VectorDatabaseSettingParameter'
            type: array
          - type: 'null'
          description: The list of available settings for the parameter.
          title: settings
        title:
          description: The title of the parameter.
          title: title
          type: string
        type:
          anyOf:
          - $ref: '#/components/schemas/VectorDatabaseSettingTypes'
          - items:
              $ref: '#/components/schemas/VectorDatabaseSettingTypes'
            type: array
          description: The type of the parameter.
          title: type
      required:
      - name
      - type
      - description
      - title
      title: VectorDatabaseSettingParameter
      type: object
    VectorDatabaseSettingTypes:
      description: The types of vector database setting parameters.
      enum:
      - string
      - integer
      - boolean
      - 'null'
      - number
      - array
      title: VectorDatabaseSettingTypes
      type: string
    VectorDatabaseSettings:
      description: Vector database retrieval settings.
      properties:
        addNeighborChunks:
          default: false
          description: Add neighboring chunks to those that the similarity search
            retrieves, such that when selected, search returns i, i-1, and i+1.
          title: addNeighborChunks
          type: boolean
        maxDocumentsRetrievedPerPrompt:
          anyOf:
          - maximum: 10.0
            minimum: 1.0
            type: integer
          - type: 'null'
          description: The maximum number of chunks to retrieve from the vector database.
          title: maxDocumentsRetrievedPerPrompt
        maxTokens:
          anyOf:
          - maximum: 51200.0
            minimum: 1.0
            type: integer
          - type: 'null'
          description: The maximum number of tokens to retrieve from the vector database.
          title: maxTokens
        maximalMarginalRelevanceLambda:
          default: 0.5
          description: Adjust the retrieval of chunks when using maximal marginal
            relevance to favor diversity (0.0) or similarity (1.0).
          maximum: 1.0
          minimum: 0.0
          title: maximalMarginalRelevanceLambda
          type: number
        retrievalMode:
          $ref: '#/components/schemas/RetrievalMode'
          default: similarity
          description: The retrieval mode to use. Similarity search or maximal marginal
            relevance.
          title: retrievalMode
        retriever:
          $ref: '#/components/schemas/VectorDatabaseRetrievers'
          default: SINGLE_LOOKUP_RETRIEVER
          title: retriever
      title: VectorDatabaseSettings
      type: object
    VectorDatabaseSettingsRequest:
      description: Specifies the vector database retrieval settings in LLM blueprint
        API requests.
      properties:
        addNeighborChunks:
          default: false
          description: Add neighboring chunks to those that the similarity search
            retrieves, such that when selected, search returns i, i-1, and i+1.
          title: addNeighborChunks
          type: boolean
        maxDocumentsRetrievedPerPrompt:
          anyOf:
          - maximum: 10.0
            minimum: 1.0
            type: integer
          - type: 'null'
          description: The maximum number of chunks to retrieve from the vector database.
          title: maxDocumentsRetrievedPerPrompt
        maxTokens:
          anyOf:
          - maximum: 51200.0
            minimum: 128.0
            type: integer
          - type: 'null'
          description: The maximum number of tokens to retrieve from the vector database.
          title: maxTokens
        maximalMarginalRelevanceLambda:
          default: 0.5
          description: Adjust the retrieval of chunks when using maximal marginal
            relevance to favor diversity (0.0) or similarity (1.0).
          maximum: 1.0
          minimum: 0.0
          title: maximalMarginalRelevanceLambda
          type: number
        retrievalMode:
          $ref: '#/components/schemas/RetrievalMode'
          default: similarity
          description: The retrieval mode to use. Similarity search or maximal marginal
            relevance.
          title: retrievalMode
        retriever:
          $ref: '#/components/schemas/VectorDatabaseRetrievers'
          default: SINGLE_LOOKUP_RETRIEVER
          title: retriever
      title: VectorDatabaseSettingsRequest
      type: object
    VectorDatabaseSource:
      description: The source of the vector database.
      enum:
      - DataRobot
      - External
      - Pinecone
      - Elasticsearch
      - Milvus
      - Postgres
      title: VectorDatabaseSource
      type: string
    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
    VersionedNotebookSchema:
      description: Versioned notebook schema.
      properties:
        created:
          allOf:
          - $ref: '#/components/schemas/RevisionActionSchema'
          description: Revision creation action information.
          title: Created
        id:
          description: Notebook ID.
          title: Id
          type: string
        isAuto:
          description: Whether the revision was autosaved.
          title: Isauto
          type: boolean
        lastViewed:
          allOf:
          - $ref: '#/components/schemas/RevisionActionSchema'
          description: Revision last viewed action information.
          title: Lastviewed
        name:
          description: Revision name.
          title: Name
          type: string
        orgId:
          description: Organization ID.
          title: Orgid
          type: string
        permissions:
          description: Notebook permissions.
          items:
            $ref: '#/components/schemas/NotebookPermission'
          type: array
        revisionId:
          description: Revision ID.
          title: Revisionid
          type: string
        settings:
          allOf:
          - $ref: '#/components/schemas/NotebookSettings'
          default:
            hide_cell_footers: false
            hide_cell_outputs: false
            hide_cell_titles: false
            highlight_whitespace: false
            show_line_numbers: false
            show_scrollers: false
          description: Notebook settings.
          title: Settings
        tags:
          description: Notebook tags.
          items:
            type: string
          title: Tags
          type: array
        updated:
          allOf:
          - $ref: '#/components/schemas/RevisionActionSchema'
          description: Revision update action information.
          title: Updated
        useCaseId:
          description: Use case ID.
          title: Usecaseid
          type: string
      required:
      - id
      - revisionId
      - name
      - isAuto
      - created
      - lastViewed
      title: VersionedNotebookSchema
      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:
      description: Warning about the enrichment rate
      properties:
        action:
          description: Suggested action to fix the relationship
          type:
          - string
          - 'null'
        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.
          type:
          - string
          - 'null'
        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: 0
          maximum: 1
          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
    WorkloadEvent:
      additionalProperties: false
      description: 'A single workload event record.


        Note: full event schema will be defined once event storage is implemented
        (P7).

        This placeholder documents the known shape.'
      properties:
        actorId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the user or system that triggered the event
          title: Actor ID
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          description: Additional event-specific details
          title: Details
        eventType:
          description: Type of event
          title: Event Type
          type: string
        id:
          description: Event ID
          title: ID
          type: string
        timestamp:
          description: When the event occurred
          format: date-time
          title: Timestamp
          type: string
        workloadId:
          description: ID of the workload this event belongs to
          title: Workload ID
          type: string
      required:
      - id
      - workloadId
      - timestamp
      - eventType
      title: WorkloadEvent
      type: object
    WorkloadEventsResponse:
      additionalProperties: false
      description: Response containing workload events.
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/WorkloadEvent'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: WorkloadEventsResponse
      type: object
    WorkloadFormatted:
      additionalProperties: false
      description: 'API representation of a workload.

        This is the formatted version returned to clients, excluding internal fields

        and including computed properties like permissions and statistics.'
      properties:
        artifact:
          anyOf:
          - $ref: '#/components/schemas/ArtifactInfoFormatted'
          - type: 'null'
          description: Basic information about the currently active artifact for this
            workload
          title: Artifact
        artifactId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the currently active artifact for this workload
          title: Artifact ID
        createdAt:
          description: Timestamp of when the entity was created
          format: date-time
          title: Created At
          type: string
        creator:
          anyOf:
          - $ref: '#/components/schemas/UserData'
          - type: 'null'
          description: Owner user details including ID, username and email
          title: Creator
        description:
          anyOf:
          - type: string
          - type: 'null'
          default: ''
          description: Workload description
          title: Description
        endpoint:
          anyOf:
          - type: string
          - type: 'null'
          description: Workload endpoint URL
          title: Endpoint
        id:
          description: Unique identifier of the entity
          title: ID
          type: string
        importance:
          $ref: '#/components/schemas/WorkloadImportance'
          default: low
          description: Workload importance level
          title: Importance
        lastResponse:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Timestamp of the last response received from this workload
          title: Last Response Time
        name:
          description: Name of the entity
          title: Name
          type: string
        owners:
          description: List of workload owners
          items:
            $ref: '#/components/schemas/UserData'
          title: Owners
          type: array
        permissions:
          $ref: '#/components/schemas/ResourcePermissions'
          description: User permissions for this workload
          title: Permissions
        protonId:
          anyOf:
          - type: string
          - type: 'null'
          description: ID of the currently active proton for this workload
          title: Proton ID
        replacement:
          anyOf:
          - $ref: '#/components/schemas/WorkloadReplacementFormatted'
          - type: 'null'
          description: Information about an active replacement process for this workload,
            if any
          title: Replacement
        requestStats:
          anyOf:
          - $ref: '#/components/schemas/RequestStats'
          - type: 'null'
          description: Request statistics for this workload
          title: Request Stats
        runtime:
          $ref: '#/components/schemas/WorkloadRuntime'
          description: Runtime configuration sourced from the current proton
          title: Runtime
        status:
          $ref: '#/components/schemas/WorkloadStatus'
          default: unknown
          description: Current workload status
          title: Status
        tags:
          $ref: '#/components/schemas/Tags'
          description: Tags associated with this workload
          title: Tags
        type:
          $ref: '#/components/schemas/ArtifactType'
          default: service
          description: Workload artifact type
          title: Type
        updatedAt:
          description: Timestamp of when the entity was last updated
          format: date-time
          title: Updated At
          type: string
      required:
      - id
      - name
      - createdAt
      - updatedAt
      title: WorkloadFormatted
      type: object
    WorkloadImportance:
      description: Importance level for workloads.
      enum:
      - critical
      - high
      - moderate
      - low
      title: WorkloadImportance
      type: string
    WorkloadListResponse:
      additionalProperties: false
      properties:
        count:
          description: The number of records on this page.
          title: Count
          type: integer
        data:
          description: The list of records.
          items:
            $ref: '#/components/schemas/WorkloadFormatted'
          title: Data
          type: array
        next:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the next page, or `null` if there is no such page.
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to the previous page, or `null` if there is no such
            page.
          title: Previous
        totalCount:
          description: The total number of records.
          title: Totalcount
          type: integer
      required:
      - totalCount
      - count
      - next
      - previous
      - data
      title: WorkloadListResponse
      type: object
    WorkloadMonitorOverallStatus:
      additionalProperties: false
      description: Overall status as reported by the workload-monitor service.
      properties:
        lastUpdated:
          description: RFC3339 timestamp of the last state transition
          title: Lastupdated
          type: string
        state:
          $ref: '#/components/schemas/ProtonStatus'
          description: Proton state mapped to team-owned ProtonStatus
        summary:
          description: Human-readable description of the current state
          title: Summary
          type: string
      required:
      - state
      - summary
      - lastUpdated
      title: WorkloadMonitorOverallStatus
      type: object
    WorkloadOperationResponse:
      additionalProperties: false
      description: 'Acknowledgement returned by asynchronous workload lifecycle operations
        (start/stop).


        The operation has been accepted and queued. Poll ``GET /workloads/{workloadId}``

        to observe the resulting status transition.'
      properties:
        status:
          description: Human-readable description of the operation outcome.
          title: Status
          type: string
        trackVia:
          description: URL to poll in order to observe the status transition.
          title: Track Via
          type: string
        workloadId:
          description: ID of the workload on which the operation was requested.
          title: Workload ID
          type: string
      required:
      - status
      - workloadId
      - trackVia
      title: WorkloadOperationResponse
      type: object
    WorkloadReplacementFormatted:
      description: Formatted replacement information for API responses.
      properties:
        candidateProtonIds:
          description: IDs of protons pending promotion during artifact replacement
          items:
            type: string
          title: Candidateprotonids
          type: array
        status:
          $ref: '#/components/schemas/ReplacementStatus'
          default: unknown
          description: Replacement status
        strategy:
          $ref: '#/components/schemas/ReplacementStrategy'
          default: rolling
          description: Replacement strategy
      title: WorkloadReplacementFormatted
      type: object
    WorkloadRuntime:
      additionalProperties: false
      description: 'Runtime configuration for a workload.


        For service and nim artifacts, all configuration is scoped inside

        ``container_groups``, each identified by name matching the artifact topology.'
      properties:
        containerGroups:
          description: Per-group runtime configuration. Each entry's name must match
            a group in the artifact.
          items:
            $ref: '#/components/schemas/GroupRuntime'
          title: Containergroups
          type: array
      title: WorkloadRuntime
      type: object
    WorkloadSettingsResponse:
      additionalProperties: false
      description: Response containing workload settings.
      properties:
        runtime:
          $ref: '#/components/schemas/WorkloadRuntime'
          description: Runtime configuration sourced from the current proton
      title: WorkloadSettingsResponse
      type: object
    WorkloadSnippet:
      properties:
        showSecrets:
          default: 'False'
          description: If true, the DATAROBOT_KEY and DATAROBOT_API_KEY will be available
            in the context.
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        workloadId:
          description: The selected workload ID.
          type: string
      required:
      - workloadId
      type: object
      x-versionadded: v2.41
    WorkloadSortQueryParam:
      anyOf:
      - $ref: '#/components/schemas/CommonSortQueryParams'
      - const: status
        description: Sort by status in ascending order (e.g., STOPPED before RUNNING)
        title: Status Ascending
        type: string
      - const: -status
        description: Sort by status in descending order (e.g., RUNNING before STOPPED)
        title: Status Descending
        type: string
      - const: importance
        description: Sort by importance in ascending order (least important first)
        title: Importance Ascending
        type: string
      - const: -importance
        description: Sort by importance in descending order (most important first)
        title: Importance Descending
        type: string
    WorkloadStatsMetricName:
      description: Metric names for workload statistics.
      enum:
      - totalRequests
      - requestsOverN
      - requestsPerMinute
      - concurrentRequests
      - responseTime
      - totalErrorRate
      title: WorkloadStatsMetricName
      type: string
    WorkloadStatsResponse:
      additionalProperties: false
      description: Response containing workload statistics.
      properties:
        concurrentRequests:
          $ref: '#/components/schemas/WorkloadsConcurrentRequestsStats'
          description: Concurrent requests statistics
        errorRate:
          $ref: '#/components/schemas/WorkloadsErrorRateStats'
          description: Error rate statistics
        requests:
          $ref: '#/components/schemas/WorkloadsRequestsStats'
          description: Request statistics across all workloads
        responseTime:
          $ref: '#/components/schemas/WorkloadsResponseTimeStats'
          description: Response time statistics
        workloads:
          $ref: '#/components/schemas/WorkloadsCountStats'
          description: Workload count statistics
      title: WorkloadStatsResponse
      type: object
    WorkloadStatus:
      description: "User-facing workload status.\n\nA subset of :class:`ProtonStatus`\
        \ \u2014 excludes internal proton-lifecycle\nstates (WARMING, DRAINING, RESTARTING)\
        \ that should never be surfaced as\na workload status."
      enum:
      - unknown
      - submitted
      - provisioning
      - launching
      - running
      - suspended
      - interrupted
      - stopping
      - stopped
      - errored
      - terminated
      title: WorkloadStatus
      type: string
    WorkloadsConcurrentRequestsStats:
      additionalProperties: false
      description: Workload concurrent requests statistics.
      properties:
        count:
          default: 0
          description: Number of concurrent requests
          title: Count
          type: integer
        trend:
          default: 0.0
          description: Trend indicator (positive = increasing)
          title: Trend
          type: number
      title: WorkloadsConcurrentRequestsStats
      type: object
    WorkloadsCountStats:
      additionalProperties: false
      description: Workload count statistics.
      properties:
        active:
          default: 0
          description: Number of active workloads
          title: Active
          type: integer
        total:
          default: 0
          description: Total number of workloads
          title: Total
          type: integer
      title: WorkloadsCountStats
      type: object
    WorkloadsErrorRateStats:
      additionalProperties: false
      description: Workload error rate statistics.
      properties:
        rate:
          default: 0.0
          description: Error rate percentage
          title: Rate
          type: number
        trend:
          default: 0.0
          description: Trend indicator (positive = increasing)
          title: Trend
          type: number
      title: WorkloadsErrorRateStats
      type: object
    WorkloadsRequestsStats:
      additionalProperties: false
      description: Workload request statistics.
      properties:
        failed:
          default: 0
          description: Number of failed requests
          title: Failed
          type: integer
        succeeded:
          default: 0
          description: Number of successful requests
          title: Succeeded
          type: integer
        total:
          default: 0
          description: Total number of requests
          title: Total
          type: integer
        trend:
          default: 0.0
          description: Trend indicator (positive = increasing)
          title: Trend
          type: number
      title: WorkloadsRequestsStats
      type: object
    WorkloadsResponseTimeStats:
      additionalProperties: false
      description: Workload response time statistics.
      properties:
        millis:
          default: 0
          description: Response time in milliseconds
          title: Millis
          type: integer
        trend:
          default: 0.0
          description: Trend indicator (positive = increasing)
          title: Trend
          type: number
      title: WorkloadsResponseTimeStats
      type: object
    WorkspaceItemResponse:
      properties:
        commitSha:
          description: SHA1 hash pointing to the original file revision (set only
            for files pulled from Git-like repositories).
          type:
          - string
          - 'null'
        created:
          description: ISO-8601 timestamp of when the file item was created.
          type: string
        fileName:
          description: The name of the file item.
          type: string
        filePath:
          description: The path of the file item.
          type: string
        fileSource:
          description: The 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.
          type:
          - string
          - 'null'
        repositoryFilePath:
          description: Full path to the file in the remote repository.
          type:
          - string
          - 'null'
        repositoryLocation:
          description: URL to remote repository from which the file was pulled (e.g.
            Git server or S3 Bucket name).
          type:
          - string
          - 'null'
        repositoryName:
          description: Name of the repository from which the file was pulled.
          type:
          - string
          - 'null'
      required:
      - created
      - fileName
      - filePath
      - fileSource
      - id
      type: object
    WorkspaceSourceCreatedResponse:
      properties:
        workspaceStateId:
          description: The 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'
          maxItems: 32
          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.
          type:
          - string
          - 'null'
        workspaceStateId:
          description: Data Engine workspace state ID.
          type: string
      required:
      - datasets
      - language
      - query
      - queryGeneratorId
      - workspaceStateId
      type: object
    WorkspaceStateResponse:
      properties:
        datasets:
          description: The source datasets in the data engine workspace.
          items:
            $ref: '#/components/schemas/WorkspaceSourceDatasetWithCredsResponse'
          type: array
        language:
          description: The language of the data engine query.
          type: string
        query:
          description: The actual SQL statement of the data engine query.
          type: string
        queryGeneratorId:
          description: The query generator ID.
          type:
          - string
          - 'null'
        runTime:
          description: The execution time of the data engine query.
          type:
          - number
          - 'null'
      required:
      - datasets
      - language
      - query
      - queryGeneratorId
      - runTime
      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 .
          type:
          - string
          - 'null'
          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
          type:
          - boolean
          - 'null'
          x-versionadded: v2.25
        keySummary:
          description: Per key summaries for Summarized Categorical or Multicategorical
            columns
          oneOf:
          - $ref: '#/components/schemas/FeatureKeySummaryResponseValidatorSummarizedCategorical'
            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
        lowerQuartile:
          description: Lower quartile point of EDA sample of the feature.
          oneOf:
          - description: Lower quartile point of EDA sample of the feature.
            type: string
          - description: Lower quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
        majorityClassCount:
          description: The number of rows with a majority class value if smart downsampling
            is applicable to this feature.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        max:
          description: Maximum value of the EDA sample of the feature.
          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
          - type: 'null'
          x-versionadded: v2.33
        mean:
          description: Arithmetic mean of the EDA sample of the feature.
          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
          - type: 'null'
          x-versionadded: v2.33
        median:
          description: Median of the EDA sample of the feature.
          oneOf:
          - description: Median of the EDA sample of the feature.
            type: string
          - description: Median of the EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.33
        min:
          description: Minimum value of the EDA sample of the feature.
          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
          - type: 'null'
          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.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        naCount:
          description: Number of missing values.
          type:
          - integer
          - 'null'
          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'
          type: array
          x-versionadded: v2.30
        sampleRows:
          description: The number of rows in the sample used to calculate the statistics.
          type: integer
          x-versionadded: v2.35
          x-versiondeprecated: v2.36
        stdDev:
          description: Standard deviation of EDA sample of the feature.
          oneOf:
          - description: Standard deviation of EDA sample of the feature.
            type: string
          - description: Standard deviation of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.33
        timeSeriesEligibilityReason:
          description: why the feature is ineligible for time series projects, or
            'suitable' if it is eligible.
          type:
          - string
          - 'null'
          x-versionadded: v2.33
        timeSeriesEligibilityReasonAggregation:
          description: why the feature is ineligible for aggregation, or 'suitable'
            if it is eligible.
          type:
          - string
          - 'null'
          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.
          type:
          - integer
          - 'null'
          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.
          type:
          - integer
          - 'null'
          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.
          type:
          - string
          - 'null'
          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.
          type:
          - string
          - 'null'
          x-versionadded: v2.24
        uniqueCount:
          description: Number of unique values.
          type:
          - integer
          - 'null'
          x-versionadded: v2.33
        upperQuartile:
          description: Upper quartile point of EDA sample of the feature.
          oneOf:
          - description: Upper quartile point of EDA sample of the feature.
            type: string
          - description: Upper quartile point of EDA sample of the feature.
            type: number
          - type: 'null'
          x-versionadded: v2.35
      required:
      - datasetId
      - datasetVersionId
      - dateFormat
      - featureType
      - id
      - majorityClassCount
      - minorityClassCount
      - name
      - sampleRows
      type: object
    handler.AuthorizeProviderResponse:
      properties:
        redirectUrl:
          type: string
        state:
          type: string
      type: object
    handler.AuthorizedOAuthProvidersListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/models.AuthorizedProvider'
          type: array
          uniqueItems: false
      type: object
    handler.CallbackResponse:
      properties:
        authorizedProvider:
          $ref: '#/components/schemas/models.AuthorizedProvider'
        userInfo:
          $ref: '#/components/schemas/oauth.User'
      type: object
    handler.DeleteOAuthProviderResponse:
      properties:
        location:
          type: string
      type: object
    handler.GetAccessTokenResponse:
      properties:
        accessToken:
          type: string
        authorizedOauthProvider:
          $ref: '#/components/schemas/models.AuthorizedProvider'
        expiresAt:
          type: string
      type: object
    handler.ListOAuthProvidersResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/models.OAuthProvider'
          type: array
          uniqueItems: false
      type: object
    handler.OAuthCallbackRequest:
      properties:
        code:
          type: string
        providerId:
          type: string
        state:
          type: string
      required:
      - code
      - providerId
      - state
      type: object
    handler.jobStatusResponse:
      properties:
        details:
          description: "Details is a slice of key-value pairs containing additional\
            \ information about the job.\nFor example, for a delete provider job,\
            \ it may include the provider ID and connected authorization IDs.\nExample\
            \ usage:\nDetails = []struct {\n    Name:  \"provider_id\",\n    Value:\
            \ \"1234\",\n},\n{\n    Name:  \"authorization_ids\",\n    Value: []string{\"\
            1234\", \"5678\"},\n}"
          items:
            $ref: '#/components/schemas/handler.keyValue'
          type: array
          uniqueItems: false
        finishedAt:
          format: date-time
          type: string
        id:
          type: string
        name:
          type: string
        orgId:
          type: string
        startedAt:
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/models.JobStatus'
        type:
          $ref: '#/components/schemas/models.JobType'
      type: object
    handler.keyValue:
      properties:
        name:
          type: string
        value:
          type: string
      type: object
    httpres.ErrorField:
      properties:
        message:
          type: string
        name:
          type: string
      type: object
    httpres.ErrorResponse:
      properties:
        errorFields:
          items:
            $ref: '#/components/schemas/httpres.ErrorField'
          type: array
          uniqueItems: false
        message:
          type: string
      type: object
    models.AuthorizedProvider:
      properties:
        createdAt:
          format: date-time
          type: string
        credentialId:
          type: string
        id:
          type: string
        oauthClientId:
          type: string
        orgId:
          type: string
        provider:
          $ref: '#/components/schemas/models.OAuthProvider'
        refreshTokenExpiresAt:
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/models.AuthzStatus'
        userId:
          type: string
      type: object
    models.AuthzStatus:
      enum:
      - active
      - expired
      - invalidOAuthClient
      - invalidProviderState
      type: string
      x-enum-varnames:
      - AuthzStatusActive
      - AuthzStatusExpired
      - AuthzStatusInvalidOAuthClient
      - AuthzInactiveProviderState
    models.JobStatus:
      enum:
      - PENDING
      - RUNNING
      - COMPLETED
      - ERROR
      type: string
      x-enum-varnames:
      - JobStatusPending
      - JobStatusRunning
      - JobStatusCompleted
      - JobStatusError
    models.JobType:
      enum:
      - DELETE_PROVIDER
      - STATS
      type: string
      x-enum-varnames:
      - JobTypeDeleteProvider
      - JobTypeStats
    models.OAuthProvider:
      properties:
        clientId:
          type: string
        createdAt:
          format: date-time
          type: string
        customScopes:
          items:
            type: string
          type: array
          uniqueItems: false
        id:
          type: string
        metadata:
          $ref: '#/components/schemas/models.ProviderMetadata'
        name:
          type: string
        orgId:
          type: string
        secureConfigId:
          type: string
        skipConsent:
          type: boolean
        status:
          $ref: '#/components/schemas/oauthprovider.Status'
        type:
          $ref: '#/components/schemas/oauthprovider.Type'
        updatedAt:
          format: date-time
          type: string
      type: object
    models.ProviderMetadata:
      properties:
        baseUrl:
          type: string
        host:
          type: string
        settingsUrl:
          type: string
      type: object
    oauth.User:
      properties:
        description:
          type: string
        email:
          type: string
        familyName:
          type: string
        givenName:
          type: string
        locale:
          type: string
        name:
          type: string
        nickName:
          type: string
        picture:
          type: string
        raw:
          additionalProperties: {}
          type: object
        sub:
          type: string
      type: object
    oauthprovider.Status:
      enum:
      - active
      - invalid
      - deleting
      - deletion_failed
      type: string
      x-enum-varnames:
      - StatusActive
      - StatusInvalid
      - StatusDeleting
      - StatusDeletionFailed
    oauthprovider.Type:
      enum:
      - github
      - gitlab
      - bitbucket
      - google
      - box
      - microsoft
      - sharepoint
      - jira
      - confluence
      type: string
      x-enum-varnames:
      - TypeGithub
      - TypeGitlab
      - TypeBitbucket
      - TypeGoogle
      - TypeBox
      - TypeMicrosoft
      - TypeSharepoint
      - TypeJira
      - TypeConfluence
    provider.CreateProviderRequest:
      properties:
        clientId:
          type: string
        clientSecret:
          type: string
        name:
          type: string
        scopes:
          description: Optional custom scopes; when set, overrides the provider's
            default scopes.
          items:
            type: string
          type: array
          uniqueItems: false
        skipConsent:
          type: boolean
        type:
          $ref: '#/components/schemas/oauthprovider.Type'
      required:
      - clientId
      - clientSecret
      - name
      - type
      type: object
    provider.UpdateProviderRequest:
      properties:
        clientSecret:
          type: string
        name:
          type: string
        skipConsent:
          type: boolean
        status:
          $ref: '#/components/schemas/oauthprovider.Status'
      type: object
  securitySchemes:
    BearerAuth:
      description: JWT Bearer Auth
      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.45.0
  x-datarobot-release-version: Latest
openapi: 3.0.3
paths:
  /:
    get:
      description: 'List all Memory Spaces accessible by the authenticated user


        * Returns offset/limit pagination with a total count.

        * Soft-deleted spaces are excluded'
      operationId: list_memory_spaces__get
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_MemorySpaceResponse_'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: List Memory Spaces
      tags:
      - agentic_memory
  /api/v2/accessRoles/:
    get:
      description: Retrieve all access roles that the user has access to, optionally
        filtering by global access roles.
      operationId: accessRoles_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: If provided, restricts results to roles only usable by the organization
          with the provided ID. Ignored when globalRoles=only.
        in: query
        name: organizationId
        required: false
        schema:
          type: string
      - description: Whether to include roles that are available to all organizations,
          along with or instead of organization-specific results.
        in: query
        name: globalRoles
        required: true
        schema:
          default: included
          enum:
          - included
          - excluded
          - only
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRoleListResponse'
          description: The created role.
      summary: Retrieve a list of access roles.
      tags:
      - user_management
      x-versionadded: v2.36
    post:
      description: Create a new access role with custom permissions and associate
        it with a particular organization.
      operationId: accessRoles_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessRoleCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRole'
          description: The created role.
        '422':
          description: Invalid organizationId; name is not unique within organization;
            or custom role limit exceeded (100 per organization).
      summary: Create a new custom access role.
      tags:
      - user_management
      x-versionadded: v2.36
  /api/v2/accessRoles/{roleId}/:
    delete:
      description: Delete a custom access role and remove it from any users, groups,
        or organizations it was assigned to.
      operationId: accessRoles_delete
      parameters:
      - description: The ID of the access role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Role successfully deleted.
        '422':
          description: Role is not a custom role.
      summary: Delete a custom access role by role ID
      tags:
      - user_management
      x-versionadded: v2.36
    get:
      description: Retrieve details about an access role.
      operationId: accessRoles_retrieve
      parameters:
      - description: The ID of the access role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRole'
          description: The requested role.
      summary: Retrieve an access role by role ID
      tags:
      - user_management
      x-versionadded: v2.36
    patch:
      description: Update the name or permissions of a custom access role.
      operationId: accessRoles_patch
      parameters:
      - description: The ID of the access role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessRoleUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRole'
          description: Role successfully updated.
        '422':
          description: Name is not unique within organization; or role is not a custom
            role.
      summary: Update a custom access role by role ID
      tags:
      - user_management
      x-versionadded: v2.36
  /api/v2/accessRoles/{roleId}/users/:
    get:
      description: Retrieve all users that have this access role assigned to them,
        any of their groups, or their organization.
      operationId: accessRolesUsers_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: Restrict results to users whose name or username partially matches
          this string.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: The ID of the access role.
        in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRoleUsersListResponse'
          description: The list of users assigned to this access role.
      summary: Retrieve a list of the users using this access role by role ID
      tags:
      - user_management
      x-versionadded: v2.36
  /api/v2/aclConnections/:
    get:
      description: 'A list of all ACL management connections for the user organization. '
      operationId: aclConnections_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACLAdminConnectionList'
          description: ''
      summary: List all ACL management connections.
      tags:
      - data_connectivity
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Synchronize access permissions to VDB and GDrive/SharePoint source
          files.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: ACL_SYNC
      x-versionadded: v2.43
    put:
      description: Create or update the ACL management connection. Default credentials
        must be defined for the data store in advance.
      operationId: aclConnections_putMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACLAdminConnectionBase'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACLAdminConnectionResponse'
          description: ''
      summary: Define the connection as ACL management.
      tags:
      - data_connectivity
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Synchronize access permissions to VDB and GDrive/SharePoint source
          files.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: ACL_SYNC
      x-versionadded: v2.43
  /api/v2/aclConnections/{dataStoreId}/:
    delete:
      operationId: aclConnections_delete
      parameters:
      - description: The ACL management connection ID.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Deactivate ACL management by data store ID
      tags:
      - data_connectivity
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Synchronize access permissions to VDB and GDrive/SharePoint source
          files.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: ACL_SYNC
      x-versionadded: v2.43
  /api/v2/agentCards/:
    get:
      description: Retrieve the list of agent cards within tenant.
      operationId: agentCards_list
      parameters:
      - description: The number of agent cards to skip. Defaults to 0.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The number of agent cards (greater than zero, max 100) to return.
          Defaults to 25.
        in: query
        name: limit
        required: true
        schema:
          default: 25
          exclusiveMinimum: 0
          maximum: 100
          type: integer
      - description: The order to sort the agent cards. Defaults to order by creation
          time in ascending order.
        in: query
        name: orderBy
        required: false
        schema:
          default: createdAt
          enum:
          - deploymentId
          - -deploymentId
          - externalId
          - -externalId
          - createdAt
          - -createdAt
          - updatedAt
          - -updatedAt
          type: string
      - description: Filter registered agents on deployment IDs.
        in: query
        name: deploymentIds
        required: false
        schema:
          items:
            type: string
          maxItems: 20
          type: array
      - description: Filter registered agents on external IDs.
        in: query
        name: externalIds
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentCardListResponse'
          description: The list of agent cards registered within tenant.
      summary: List registered agent cards.
      tags:
      - agent_cards
      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.45
  /api/v2/applicationTemplates/:
    get:
      description: List the application templates the user has access to.
      operationId: applicationTemplates_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: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationTemplateListResponse'
          description: ''
      summary: List the application templates the user has access to.
      tags:
      - application_templates
      x-versionadded: v2.35
    post:
      description: Create an application template.
      operationId: applicationTemplates_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationTemplateCreate'
      responses:
        '201':
          description: ''
        '403':
          description: Permission settings do not allow creating templates.
      summary: Create an application template.
      tags:
      - application_templates
      x-versionadded: v2.35
  /api/v2/applicationTemplates/{applicationTemplateId}/:
    delete:
      description: Delete an application template.
      operationId: applicationTemplates_delete
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: Permission settings do not allow deleting templates.
        '404':
          description: The template is either global, preventing deletion, or does
            not exist.
      summary: Delete an application template by application template ID
      tags:
      - application_templates
      x-versionadded: v2.35
    patch:
      description: Update an application template.
      operationId: applicationTemplates_patch
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationTemplateUpdate'
      responses:
        '204':
          description: ''
        '403':
          description: Permission settings do not allow updating templates.
        '404':
          description: The template is either global, preventing updates, or does
            not exist.
      summary: Update an application template by application template ID
      tags:
      - application_templates
      x-versionadded: v2.35
  /api/v2/applicationTemplates/{applicationTemplateId}/clone/:
    post:
      description: Clone an application template into a codespace.
      operationId: applicationTemplatesClone_create
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationTemplateCloneResponse'
          description: ''
        '403':
          description: Permission settings do not allow cloning templates.
        '404':
          description: The template does not exist.
        '422':
          description: An error ocurred when creating the codespace.
      summary: Clone an application template into a codespace by application template
        ID
      tags:
      - application_templates
      x-versionadded: v2.35
  /api/v2/applicationTemplates/{applicationTemplateId}/media/:
    delete:
      description: Delete an application template image/gif.
      operationId: applicationTemplatesMedia_deleteMany
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: Permission settings do not allow allow deleting media from
            templates.
        '404':
          description: The template is either global, preventing media deletion, or
            does not exist.
      summary: Delete an application template image/gif.  by application template
        ID
      tags:
      - application_templates
      x-versionadded: v2.35
    get:
      description: Retrieve an application template image.
      operationId: applicationTemplatesMedia_list
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationTemplateMediaResponse'
          description: ''
        '404':
          description: The template media does not exist or the template does not
            exist.
      summary: Retrieve an application template image by application template ID
      tags:
      - application_templates
      x-versionadded: v2.35
    post:
      description: Upload an application template image/gif.
      operationId: applicationTemplatesMedia_create
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationTemplateMediaUpload'
      responses:
        '202':
          description: ''
        '403':
          description: Permission settings do not allow allow uploading media to templates.
        '404':
          description: The template is either global, preventing media upload, or
            does not exist.
      summary: Upload an application template image/gif.  by application template
        ID
      tags:
      - application_templates
      x-versionadded: v2.35
  /api/v2/applicationTemplates/{applicationTemplateId}/repositoryUrls/:
    get:
      description: Get the resolved clone URL for an application template repository.
      operationId: applicationTemplatesRepositoryUrls_list
      parameters:
      - description: The ID of the template.
        in: path
        name: applicationTemplateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationTemplateRepositoryUrlResponse'
          description: ''
        '404':
          description: The template does not exist.
      summary: Get the resolved clone URL by application template ID
      tags:
      - application_templates
      x-versionadded: v2.43
  /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:
      - no_code_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:
      - no_code_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
      tags:
      - no_code_applications
      x-versionadded: v2.32
  /api/v2/applications/{applicationId}/:
    delete:
      description: Delete an application
      operationId: applications_delete
      parameters:
      - description: Determines whether or not DataRobot deletes the underlying entity,
          or just marks it as deleted.
        in: query
        name: hard
        required: false
        schema:
          default: false
          type: boolean
      - 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 by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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/ by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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 by
        application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_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 by application ID
      tags:
      - no_code_applications
      x-versionadded: v2.24
  /api/v2/approvalPolicies/:
    get:
      description: List Approval Policies.
      operationId: approvalPolicies_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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:
      - approval_workflows
      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:
      - approval_workflows
      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 by approval policy ID
      tags:
      - approval_workflows
      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 by approval policy ID
      tags:
      - approval_workflows
      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 by approval policy ID
      tags:
      - approval_workflows
      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: The 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: 0
          maximum: 1000
          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 by approval policy ID
      tags:
      - approval_workflows
      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
          type:
          - string
          - 'null'
      - description: Value of the entity field to filter policies by.
        in: query
        name: fieldValue
        required: false
        schema:
          maxLength: 50
          type:
          - string
          - 'null'
      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:
      - approval_workflows
      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:
      - approval_workflows
      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
      tags:
      - compliance_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
            - MODEL_COMPLIANCE_GEN_AI
            type: string
            x-enum-versionadded:
            - value: DEPLOYMENT_REPORT
              x-versionadded: v2.24
            - value: MODEL_COMPLIANCE_GEN_AI
              x-versionadded: v2.35
          - items:
              enum:
              - AUTOPILOT_SUMMARY
              - MODEL_COMPLIANCE
              - DEPLOYMENT_REPORT
              - MODEL_COMPLIANCE_GEN_AI
              type: string
              x-enum-versionadded:
              - value: DEPLOYMENT_REPORT
                x-versionadded: v2.24
              - value: MODEL_COMPLIANCE_GEN_AI
                x-versionadded: v2.35
            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:
      - compliance_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:
      - compliance_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 by document ID
      tags:
      - compliance_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 by document ID
      tags:
      - compliance_documentation
      x-versionadded: v2.24
  /api/v2/batchJobs/:
    get:
      description: Get a collection of batch jobs by statuses
      operationId: batchJobs_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.30
      - 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.30
      - 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.30
      - 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.30
      - description: Includes only job by specific id
        in: query
        name: jobId
        required: false
        schema:
          type: string
        x-versionadded: v2.30
      - 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.30
      - description: '[DEPRECATED - replaced with RBAC permission model] - No effect'
        in: query
        name: allJobs
        required: false
        schema:
          default: false
          type: boolean
        x-versionadded: v2.30
        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.30
      - 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.30
      - 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.30
      - description: Includes only jobs that have the batch job type that matches
          this flag. Repeat the parameter for filtering on multiple types.
        in: query
        name: batchJobType
        required: false
        schema:
          oneOf:
          - enum:
            - monitoring
            - prediction
            type: string
          - items:
              enum:
              - monitoring
              - prediction
              type: string
            type: array
        x-versionadded: v2.30
      - description: Includes only jobs for these particular intakes type
        in: query
        name: intakeType
        required: false
        schema:
          oneOf:
          - enum:
            - local_file
            - azure
            - bigquery
            - dataStage
            - databricks
            - dataset
            - datasphere
            - dss
            - gcp
            - http
            - jdbc
            - localFile
            - recipe
            - s3
            - snowflake
            - synapse
            - trino
            type: string
          - items:
              enum:
              - local_file
              - azure
              - bigquery
              - dataStage
              - databricks
              - dataset
              - datasphere
              - dss
              - gcp
              - http
              - jdbc
              - localFile
              - recipe
              - s3
              - snowflake
              - synapse
              - trino
              type: string
            type: array
        x-versionadded: v2.30
      - description: Includes only jobs for these particular outputs type
        in: query
        name: outputType
        required: false
        schema:
          oneOf:
          - enum:
            - local_file
            - azure
            - bigquery
            - databricks
            - datasphere
            - gcp
            - http
            - jdbc
            - localFile
            - s3
            - snowflake
            - synapse
            - trino
            type: string
          - items:
              enum:
              - local_file
              - azure
              - bigquery
              - databricks
              - datasphere
              - gcp
              - http
              - jdbc
              - localFile
              - s3
              - snowflake
              - synapse
              - trino
              type: string
            type: array
        x-versionadded: v2.30
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobListResponse'
          description: A list of Batch job objects
      summary: List batch jobs
      tags:
      - batch_predictions
      x-versionadded: v2.35
  /api/v2/batchJobs/fromJobDefinition/:
    post:
      description: Launches a one-time batch job based off of the previously supplied
        definition referring to the job definition ID and puts it on the queue.
      operationId: batchJobsFromJobDefinition_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchPredictionJobDefinitionId'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobResponse'
          description: Job details for the created Batch Prediction job
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
        '422':
          description: 'Could not create a Batch job. Possible reasons: {}'
      summary: Launch a Batch job
      tags:
      - batch_predictions
      x-versionadded: v2.35
  /api/v2/batchJobs/{batchJobId}/:
    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: batchJobs_delete
      parameters:
      - description: ID of the Batch job
        in: path
        name: batchJobId
        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.30
      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 job by batch job ID
      tags:
      - batch_predictions
      x-versionadded: v2.35
    get:
      description: Retrieve a Batch job.
      operationId: batchJobs_retrieve
      parameters:
      - description: ID of the Batch job
        in: path
        name: batchJobId
        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.30
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobResponse'
          description: Job details for the requested Batch job
      summary: Retrieve Batch job by batch job ID
      tags:
      - batch_predictions
      x-versionadded: v2.35
  /api/v2/batchJobs/{batchJobId}/csvUpload/:
    put:
      description: Stream CSV data to the job. Only available for jobs thatuses the
        localFile intake option.
      operationId: batchJobsCsvUpload_putMany
      parameters:
      - description: ID of the Batch job
        in: path
        name: batchJobId
        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.30
      responses:
        '202':
          description: Job data was successfully submitted
        '404':
          description: Job does not exist or does not require data
        '409':
          description: Dataset upload has already begun
        '415':
          description: Not acceptable MIME type
        '422':
          description: Job was "ABORTED" due to too many errors in the data
      summary: Stream CSV data by batch job ID
      tags:
      - batch_predictions
      x-versionadded: v2.35
  /api/v2/batchJobs/{batchJobId}/download/:
    get:
      description: This is only valid for jobs scored using the "localFile" output
        option
      operationId: batchJobsDownload_list
      parameters:
      - description: ID of the Batch job
        in: path
        name: batchJobId
        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.30
      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 job by batch job ID
      tags:
      - batch_predictions
      x-versionadded: v2.35
  /api/v2/batchMonitoring/:
    post:
      description: Submit the configuration for the job and it will be submitted to
        the queue
      operationId: batchMonitoring_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchMonitoringJobCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchJobResponse'
          description: Job details for the created Batch Monitoring job
      summary: Creates a new Batch Monitoring job
      tags:
      - monitoring_jobs
      x-versionadded: v2.35
  /api/v2/batchMonitoringJobDefinitions/:
    get:
      description: List all Batch Monitoring jobs definitions available
      operationId: batchMonitoringJobDefinitions_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/BatchMonitoringJobDefinitionsListResponse'
          description: List of all available jobs
        '422':
          description: Your input data or query arguments did not work together
      summary: List Batch Monitoring job definitions
      tags:
      - monitoring_jobs
      x-versionadded: v2.35
    post:
      description: Create a Batch Monitoring Job definition. A configuration for a
        Batch Monitoring job which can either be executed manually upon request or
        on scheduled intervals, if enabled. The API payload is the same as for `/batchJobs`
        along with optional ``enabled`` and ``schedule`` items.
      operationId: batchMonitoringJobDefinitions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchMonitoringJobDefinitionsCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchMonitoringJobDefinitionsResponse'
          description: Job details for the created Batch Monitoring 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 incompatible or missing
            parameters to create a fully functioning job definition
      summary: Creates a new Batch Monitoring job definition
      tags:
      - monitoring_jobs
      x-versionadded: v2.35
  /api/v2/batchMonitoringJobDefinitions/{jobDefinitionId}/:
    delete:
      description: Delete a Batch Prediction job definition
      operationId: batchMonitoringJobDefinitions_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 by job definition ID
      tags:
      - monitoring_jobs
      x-versionadded: v2.35
    get:
      description: Retrieve a Batch Monitoring job definition
      operationId: batchMonitoringJobDefinitions_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/BatchMonitoringJobDefinitionsResponse'
          description: Job details for the requested Batch Monitoring job definition
        '404':
          description: Job was deleted, never existed or you do not have access to
            it
      summary: Retrieve Batch Monitoring job definition by job definition ID
      tags:
      - monitoring_jobs
      x-versionadded: v2.35
    patch:
      description: Update a Batch Monitoring job definition
      operationId: batchMonitoringJobDefinitions_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/BatchMonitoringJobDefinitionsUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchMonitoringJobDefinitionsResponse'
          description: Job details for the updated Batch Monitoring job definition
        '403':
          description: You are not authorized to alter the contents of this monitoring
            job 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 monitoring job that was already existing
            within your organization
        '422':
          description: 'Could not update the monitoring job. Possible reasons: {}'
      summary: Update Batch Monitoring job definition by job definition ID
      tags:
      - monitoring_jobs
      x-versionadded: v2.35
  /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:
      - batch_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:
      - batch_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 by job definition ID
      tags:
      - batch_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 by job definition ID
      tags:
      - batch_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
        '422':
          description: 'Could not update the job definition. Possible reasons: {}'
      summary: Update Batch Prediction job definition by job definition ID
      tags:
      - batch_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 by job definition ID
      tags:
      - batch_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
            - databricks
            - dataset
            - datasphere
            - dss
            - gcp
            - http
            - jdbc
            - localFile
            - recipe
            - s3
            - snowflake
            - synapse
            - trino
            type: string
          - items:
              enum:
              - local_file
              - azure
              - bigquery
              - dataStage
              - databricks
              - dataset
              - datasphere
              - dss
              - gcp
              - http
              - jdbc
              - localFile
              - recipe
              - s3
              - snowflake
              - synapse
              - trino
              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
            - databricks
            - datasphere
            - gcp
            - http
            - jdbc
            - localFile
            - s3
            - snowflake
            - synapse
            - trino
            type: string
          - items:
              enum:
              - local_file
              - azure
              - bigquery
              - databricks
              - datasphere
              - gcp
              - http
              - jdbc
              - localFile
              - s3
              - snowflake
              - synapse
              - trino
              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:
      - batch_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:
      - batch_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
      tags:
      - batch_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
        '422':
          description: 'Could not create a Batch job. Possible reasons: {}'
      summary: Launch a Batch Prediction job
      tags:
      - batch_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 by prediction job ID
      tags:
      - batch_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 by prediction job ID
      tags:
      - batch_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 by prediction job ID
      tags:
      - batch_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 by prediction job ID
      tags:
      - batch_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 by prediction job ID
      tags:
      - batch_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 by prediction job ID
      tags:
      - batch_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 by prediction
        job ID
      tags:
      - batch_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
      tags:
      - user_management
      x-versionadded: v2.29
  /api/v2/calendarCountryCodes/:
    get:
      description: Retrieves the list of allowed country codes to request preloaded
        calendar generation for.
      operationId: calendarCountryCodes_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreloadedCalendarListResponse'
          description: The list of allowed country codes that have the generated preloaded
            calendars.
      summary: Retrieve the list of allowed country codes
      tags:
      - features
      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: The list of calendar objects.
      summary: List all available calendars
      tags:
      - features
      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
      tags:
      - features
      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:
      - features
      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 a dataset
      tags:
      - features
      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 by calendar ID
      tags:
      - features
      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 by calendar ID
      tags:
      - features
      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 by calendar ID
      tags:
      - features
      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 by calendar ID
      tags:
      - features
      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: The request to update the access control for this calendar
            was successful.
        '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 by calendar ID
      tags:
      - features
      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-connector-v1
            - dr-database-v1
            type: string
          - items:
              enum:
              - local
              - url
              - hdfs
              - jdbc
              - spark
              - dr-connector-v1
              - 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
            - SAMPLE
            - TRAINING
            type: string
          - items:
              enum:
              - BATCH_PREDICTIONS
              - PREDICTION
              - SAMPLE
              - 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
          - files
          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:
      - data_registry
      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 by catalog ID
      tags:
      - data_registry
      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 by catalog ID
      tags:
      - data_registry
      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: The 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: 0
          maximum: 1000
          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:
      - approval_workflows
      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:
      - approval_workflows
      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 by change request ID
      tags:
      - approval_workflows
      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 by change request ID
      tags:
      - approval_workflows
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/requestReview/:
    post:
      description: Request review for Change Request with the given ID.
      operationId: changeRequestsRequestReview_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/ChangeRequestRequestReview'
      responses:
        '202':
          description: ''
      summary: Request Change Request Review by change request ID
      tags:
      - approval_workflows
      x-versionadded: v2.38
  /api/v2/changeRequests/{changeRequestId}/reviews/:
    get:
      description: List Change Request reviews.
      operationId: changeRequestsReviews_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by change request ID
      tags:
      - approval_workflows
      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 by change request ID
      tags:
      - approval_workflows
      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 by change request ID
      tags:
      - approval_workflows
      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 by change request ID
      tags:
      - approval_workflows
      x-versionadded: v2.28
  /api/v2/changeRequests/{changeRequestId}/suggestedReviewers/:
    get:
      description: List users, suggested to review the Change Request.
      operationId: changeRequestsSuggestedReviewers_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by change request ID
      tags:
      - approval_workflows
      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
      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/ClusterLicenseRetrieveResponseLicense'
          description: ''
        '422':
          description: License is invalid or has expired.
      summary: Check if a license is valid.
      tags:
      - infrastructure
      x-versionadded: v2.23
  /api/v2/codeSnippets/:
    get:
      description: Retrieve a list of available code snippets for the given parameters.
      operationId: codeSnippets_list
      parameters:
      - description: The selected template type the generated snippet or notebook
          should be for (i.e. dataset, model, etc.).
        in: query
        name: templateType
        required: true
        schema:
          enum:
          - model
          - prediction
          - workload
          type: string
      - description: The selected language the generated snippet or notebook should
          be written in.
        in: query
        name: language
        required: true
        schema:
          enum:
          - curl
          - powershell
          - python
          - qlik
          type: string
      - description: Optional comma separated list of sub filters to limit the returned
          notebooks.
        in: query
        name: filters
        required: false
        schema:
          maxLength: 255
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeSnippetListResponse'
          description: The list of snippets with descriptions and ID tags.
      summary: Retrieve available code snippets.
      tags:
      - no_code_applications
      x-versionadded: v2.35
    post:
      description: Retrieve a code snippet to be displayed in the UI.
      operationId: codeSnippets_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeSnippetCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeSnippetResponse'
          description: The generated code snippet.
      summary: Retrieve a code snippet.
      tags:
      - no_code_applications
      x-versionadded: v2.35
  /api/v2/codeSnippets/download/:
    post:
      description: Retrieve a code snippet to be displayed in the UI.
      operationId: codeSnippetsDownload_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeSnippetCreate'
      responses:
        '200':
          description: The code snippet file of the selected code snippet.
      summary: Create download (no_code_applications)
      tags:
      - no_code_applications
      x-versionadded: v2.35
  /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:
      - value_tracker
      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 by comment ID
      tags:
      - value_tracker
      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 by comment ID
      tags:
      - value_tracker
      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 by comment ID
      tags:
      - value_tracker
      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: 0
          maximum: 100
          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
          - experimentContainer
          - deployment
          - workload
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentList'
          description: ''
      summary: List comments by entitytype
      tags:
      - value_tracker
      x-versionadded: v2.24
  /api/v2/complianceDocTemplates/:
    get:
      description: List user's custom-built compliance documentation templates.
      operationId: complianceDocTemplates_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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:
          type:
          - string
          - 'null'
        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
          - textGeneration
          - timeSeries
          type:
          - string
          - 'null'
        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:
      - compliance_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:
      - compliance_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. The ``normal``
          template is applicable for all AutoML projects that are not time series.
          The ``timeSeries`` template is only applicable to time series projects.The
          ``textGeneration`` template is only applicable to text generation registry
          models.
        in: query
        name: type
        required: true
        schema:
          default: normal
          enum:
          - normal
          - textGeneration
          - 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:
      - compliance_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 by template ID
      tags:
      - compliance_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 by template ID
      tags:
      - compliance_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 by template
        ID
      tags:
      - compliance_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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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 the template's access control list by template ID
      tags:
      - compliance_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 the template's access controls by template ID
      tags:
      - compliance_documentation
      x-versionadded: v2.22
  /api/v2/credentials/:
    get:
      description: List all sets of credentials available for given user.
      operationId: credentials_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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_oauth
            - azure_sas
            - azure_service_principal
            - basic
            - bearer
            - box_jwt
            - client_id_and_secret
            - databricks_access_token_account
            - databricks_service_principal_account
            - external_oauth_provider
            - gcp
            - oauth
            - rsa
            - s3
            - sap_oauth
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_oauth
              - azure_sas
              - azure_service_principal
              - basic
              - bearer
              - box_jwt
              - client_id_and_secret
              - databricks_access_token_account
              - databricks_service_principal_account
              - external_oauth_provider
              - gcp
              - oauth
              - rsa
              - s3
              - sap_oauth
              - 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
      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: The 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: 0
          maximum: 1000
          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 by association ID
      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 by credential ID
      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 by credential ID
      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 by credential ID
      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: The 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: 0
          maximum: 1000
          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_oauth
            - azure_sas
            - azure_service_principal
            - basic
            - bearer
            - box_jwt
            - client_id_and_secret
            - databricks_access_token_account
            - databricks_service_principal_account
            - external_oauth_provider
            - gcp
            - oauth
            - rsa
            - s3
            - sap_oauth
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_oauth
              - azure_sas
              - azure_service_principal
              - basic
              - bearer
              - box_jwt
              - client_id_and_secret
              - databricks_access_token_account
              - databricks_service_principal_account
              - external_oauth_provider
              - gcp
              - oauth
              - rsa
              - s3
              - sap_oauth
              - 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 by credential ID
      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:
        '204':
          description: Credentials association updated.
        '404':
          description: Requested credentials not found
        '409':
          description: One or more associations already exist 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 by credential ID
      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 by credential ID
      tags:
      - credentials
      x-versionadded: v2.30
  /api/v2/customApplicationSources/:
    get:
      description: The list of custom application sources.
      operationId: customApplicationSources_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: 0
          type: integer
      - description: The sort order applied to the list of custom application sources.
          Prefix the attribute name with a dash to sort in descending order, e.g.
          "-createdAt".
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - name
          - -name
          - createdAt
          - -createdAt
          - updatedAt
          - -updatedAt
          type: string
      - description: Allows for searching custom application sources by name.
        in: query
        name: name
        required: false
        schema:
          maxLength: 255
          minLength: 1
          type: string
      - description: Filter custom application sources to return only those created
          by the specified user.
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: Filter application sources modified on or after this timestamp.
        in: query
        name: updatedAtStartTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter application sources modified before this timestamp.
        in: query
        name: updatedAtEndTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter application sources created on or after this timestamp.
        in: query
        name: createdAtStartTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter application sources created before this timestamp.
        in: query
        name: createdAtEndTs
        required: false
        schema:
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceListResponse'
          description: ''
      summary: The list of custom application sources created
      tags:
      - custom_applications
      x-versionadded: v2.37
    post:
      description: Create a custom application source.
      operationId: customApplicationSources_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSource'
          description: ''
        '202':
          description: Creation has successfully started.
        '403':
          description: User does not have permission to create a source.
        '422':
          description: Custom application source could not be created with the given
            input.
      summary: Create a custom application source.
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/fromCustomTemplate/:
    post:
      description: Create a custom application source from a template.
      operationId: customApplicationSourcesFromCustomTemplate_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceFromGalleryTemplateCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSource'
          description: ''
        '202':
          description: The custom application source creation process has successfully
            started. See the location header.
        '403':
          description: The current user does not have permission to create a custom
            application source.
        '422':
          description: A custom application source could not be created with the selected
            custom template.
      summary: Create a custom application source
      tags:
      - custom_applications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables Custom Templates.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_TEMPLATES
      x-versionadded: v2.35
  /api/v2/customApplicationSources/{appSourceId}/:
    delete:
      description: Delete a custom application source.
      operationId: customApplicationSources_delete
      parameters:
      - description: Marks that this application source should be hard deleted instead
          of soft deleted.
        in: query
        name: hardDelete
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The source has been deleted.
      summary: Delete a custom application source by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    get:
      description: Retrieve a source.
      operationId: customApplicationSources_retrieve
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSource'
          description: ''
      summary: Retrieve a custom application source by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    patch:
      description: Update a source's name.
      operationId: customApplicationSources_patch
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceUpdate'
      responses:
        '204':
          description: The source has been updated.
      summary: Update a custom application source's name by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/{appSourceId}/sharedRoles/:
    get:
      description: Get a list of users, groups, and organizations with access to this
        application source.
      operationId: customApplicationSourcesSharedRoles_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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: ''
      summary: Get a list of users, groups, and organizations with access by app source
        ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    patch:
      description: Share an application source with a user, group, or organization.
      operationId: customApplicationSourcesSharedRoles_patchMany
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationSharingUpdateOrRemove'
      responses:
        '204':
          description: The roles were updated successfully.
        '422':
          description: The request was formatted improperly.
      summary: Share an application source by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/{appSourceId}/versions/:
    get:
      description: List of custom application source versions.
      operationId: customApplicationSourcesVersions_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: 0
          type: integer
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceVersionListResponse'
          description: ''
      summary: Paginated list of custom application source versions of the specified
        by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    post:
      description: Create a custom application source.
      operationId: customApplicationSourcesVersions_create
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceVersionCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceVersion'
          description: ''
        '201':
          description: Source version was successfully created.
        '403':
          description: User does not have permission to create a new source version.
        '422':
          description: Custom application source version could not be created with
            the given input.
      summary: Create a custom application source version by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/:
    delete:
      description: Delete a custom application source version.
      operationId: customApplicationSourcesVersions_delete
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The source version has been deleted.
      summary: Delete a custom application source version if it is still mutable by
        app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    get:
      description: Retrieve a source version.
      operationId: customApplicationSourcesVersions_retrieve
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceVersion'
          description: ''
      summary: Retrieve a custom application source version by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    patch:
      description: Update the source version
      operationId: customApplicationSourcesVersions_patch
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceVersionUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceVersion'
          description: ''
      summary: Update a custom application source version by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/archive/:
    get:
      description: Download all files from a Custom Application Source version as
        a zip archive.
      operationId: customApplicationSourcesVersionsArchive_list
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/zip:
              schema:
                format: binary
                type: string
          description: A zip archive containing all files in the source version.
          headers:
            Content-Disposition:
              description: Specifies the zip filename derived from the version label
                (e.g. "attachment; filename=v1.0.zip").
              schema:
                type: string
      summary: Download Custom Application Source version files as a zip archive by
        app source ID
      tags:
      - custom_applications
      x-versionadded: v2.43
  /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/fromCodespace/:
    post:
      description: Update files in the source version from Codespace.
      operationId: customApplicationSourcesVersionsFromCodespace_create
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceVersionFromCodespace'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceVersionFromCodespaceResponse'
          description: ''
        '202':
          description: Task for updating source applied.
      summary: Update the custom application source version by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/items/{itemId}/:
    get:
      description: Retrieve a file stored inside a custom application source version.
      operationId: customApplicationSourcesVersionsItems_retrieve
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      - description: The ID of file item inside of the application source version.
        in: path
        name: itemId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationItemRetrieve'
          description: ''
      summary: Retrieve a file by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplicationSources/{appSourceId}/versions/{appSourceVersionId}/toCodespace/:
    post:
      description: Update a codespace with files from the source version.
      operationId: customApplicationSourcesVersionsToCodespace_create
      parameters:
      - description: The ID of the application source.
        in: path
        name: appSourceId
        required: true
        schema:
          type: string
      - description: The ID of the application source version.
        in: path
        name: appSourceVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationSourceVersionToCodespace'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationSourceVersionFromCodespaceResponse'
          description: ''
        '202':
          description: Task for uploading files to codespace applied.
      summary: Update a codespace by app source ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/:
    get:
      description: The list of applications created by the currently authenticated
        user.
      operationId: customApplications_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: 0
          type: integer
      - description: The sort order applied to the list of custom applications. Prefix
          the attribute name with a dash to sort in descending order, e.g. "-createdAt".
          Additional sorting options include "bundleSize" and "replicas".
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - name
          - -name
          - createdAt
          - -createdAt
          - updatedAt
          - -updatedAt
          - bundleSize
          - -bundleSize
          - replicas
          - -replicas
          type: string
      - description: Allows for searching custom applications by name.
        in: query
        name: name
        required: false
        schema:
          maxLength: 512
          minLength: 1
          type: string
      - description: Allows you to get custom applications created only from specific
          sources. To find apps not linked to a custom application source, use the
          value "null".
        in: query
        name: customApplicationSourceId
        required: false
        schema:
          oneOf:
          - anyOf:
            - type: string
            - enum:
              - 'null'
              type: string
          - items:
              anyOf:
              - type: string
              - enum:
                - 'null'
                type: string
            maxItems: 100
            type: array
      - description: Whether or not you want to include the name of the application
          source andthe label of the source version.
        in: query
        name: includeSourceLabels
        required: false
        schema:
          default: false
          type: boolean
      - description: Whether we should only fetch apps created from a custom application
          source.
        in: query
        name: requireSource
        required: false
        schema:
          default: false
          type: boolean
      - description: Filter custom applications to return only those created by the
          specified user.
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: Filter applications by status.
        in: query
        name: status
        required: false
        schema:
          oneOf:
          - enum:
            - created
            - failed
            - initializing
            - paused
            - publishing
            - running
            type: string
          - items:
              enum:
              - created
              - failed
              - initializing
              - paused
              - publishing
              - running
              type: string
            maxItems: 10
            type: array
      - description: Filter applications modified on or after this timestamp.
        in: query
        name: updatedAtStartTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter applications modified before this timestamp.
        in: query
        name: updatedAtEndTs
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter applications by external access enablement status.
        in: query
        name: externalAccessEnabled
        required: false
        schema:
          type: boolean
      - description: Filter applications by resource bundle label.
        in: query
        name: resourceLabel
        required: false
        schema:
          maxLength: 256
          type: string
      - description: Filter applications with replica count greater than or equal
          to this value.
        in: query
        name: replicasMin
        required: false
        schema:
          type: integer
      - description: Filter applications with replica count less than or equal to
          this value.
        in: query
        name: replicasMax
        required: false
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationListResponse'
          description: ''
      summary: The list of applications created by the currently authenticated user.
      tags:
      - custom_applications
      x-versionadded: v2.37
    post:
      description: Create a custom application
      operationId: customApplications_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomApplicationCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplication'
          description: ''
        '202':
          description: Creation has successfully started. See the Location header.
        '403':
          description: User does not have permission to launch application of provided
            type.
        '422':
          description: Application could not be created with the given input.
      summary: Create a custom application
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/{applicationId}/:
    delete:
      description: Delete an application
      operationId: customApplications_delete
      parameters:
      - description: Marks that this application should be hard deleted instead of
          soft deleted.
        in: query
        name: hardDelete
        required: false
        schema:
          default: 'true'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The application has been deleted.
      summary: Delete an application by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    get:
      description: Retrieve an application
      operationId: customApplications_retrieve
      parameters:
      - description: Whether or not you want to include the name of the application
          source andthe label of the source version.
        in: query
        name: includeSourceLabels
        required: false
        schema:
          default: false
          type: boolean
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplication'
          description: ''
      summary: Retrieve an application by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    patch:
      description: Update an application's name
      operationId: customApplications_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/CustomApplicationUpdate'
      responses:
        '204':
          description: The application has been updated.
      summary: Update an application's name by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/{applicationId}/history/:
    get:
      description: Retrieve an application's publication history.
      operationId: customApplicationsHistory_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: 0
          type: integer
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomApplicationsHistoryListResponse'
          description: ''
      summary: Retrieve an application's publication history by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/{applicationId}/logs/:
    get:
      description: Retrieve an application's logs
      operationId: customApplicationsLogs_list
      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/CustomApplicationLogs'
          description: ''
      summary: Retrieve an application's logs by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/{applicationId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations that have an access
        to this application
      operationId: customApplicationsSharedRoles_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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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/SharingListV2Response'
          description: ''
      summary: Get a list of users, groups and organizations that have an access by
        application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
    patch:
      description: Share an application with a user, group, or organization
      operationId: customApplicationsSharedRoles_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/ApplicationSharingUpdateOrRemove'
      responses:
        '204':
          description: The roles were updated successfully.
        '422':
          description: The request was formatted improperly.
      summary: Share an application by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/{applicationId}/usages/:
    get:
      description: Retrieve an application's usages
      operationId: customApplicationsUsages_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: 0
          type: integer
      - description: Filter visits on or after this UTC timestamp (inclusive). ISO
          8601 format.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: Filter visits on or before this UTC timestamp (inclusive). ISO
          8601 format.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          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/CustomApplicationsUsagesListResponse'
          description: ''
      summary: Retrieve an application's usages by application ID
      tags:
      - custom_applications
      x-versionadded: v2.37
  /api/v2/customApplications/{applicationId}/usages/download/:
    get:
      description: Download an application's access logs
      operationId: customApplicationsUsagesDownload_list
      parameters:
      - description: Filter visits on or after this UTC timestamp (inclusive). ISO
          8601 format. Required.
        in: query
        name: start
        required: true
        schema:
          format: date-time
          type: string
      - description: Filter visits on or before this UTC timestamp (inclusive). ISO
          8601 format. Required.
        in: query
        name: end
        required: true
        schema:
          format: date-time
          type: string
      - description: The ID of the application
        in: path
        name: applicationId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Download an application's access logs by application ID
      tags:
      - custom_applications
      x-versionadded: v2.44
  /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 by image ID
      tags:
      - custom_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 by image ID
      tags:
      - custom_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_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: 0
          maximum: 1000
          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
          maxItems: 4
          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_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_jobs
      x-versionadded: v2.33
  /api/v2/customJobs/fromGalleryTemplate/:
    post:
      description: Create a custom job.
      feature_flags:
      - &id003
        description: Enables template gallery for generic and notification Custom
          Jobs and updates Custom Hosted Metrics gallery UI
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: CUSTOM_JOBS_TEMPLATE_GALLERY
      maturity: GA_ALL
      operationId: customJobsFromGalleryTemplate_create
      public_preview: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomJobFromTemplateGallery'
      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 jobs from a gallery template
      tags:
      - custom_jobs
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - description: Enables Custom Templates.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_TEMPLATES
      - *id003
  /api/v2/customJobs/fromHostedCustomMetricGalleryTemplate/:
    post:
      description: Creates a custom job from the hosted custom metric template.
      operationId: customJobsFromHostedCustomMetricGalleryTemplate_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomJobFromGalleryTemplateCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomJobResponse'
          description: Custom metric test job creation started.
        '403':
          description: User does not have permission to create a custom job.
      summary: Creates a custom job
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
  /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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - custom_jobs
      x-versionadded: v2.33
  /api/v2/customJobs/{customJobId}/customMetrics/:
    get:
      description: List all of the custom metrics associated with a custom job.
      operationId: customJobsCustomMetrics_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: 0
          type: integer
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCreateFromCustomJobResponse'
          description: Custom metrics associated with custom job.
        '403':
          description: User does not have permission to custom jobs.
      summary: List all of the custom metrics associated by custom job ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
  /api/v2/customJobs/{customJobId}/customMetrics/{customMetricId}/:
    delete:
      description: Delete a custom metric associated with a custom job.
      operationId: customJobsCustomMetrics_delete
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom metric.
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
        x-versionadded: v2.34
      responses:
        '204':
          description: ''
        '403':
          description: User does not have permission to custom jobs.
      summary: Delete a custom metric associated by custom job ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
    patch:
      description: Update custom metric associated with a custom job.
      operationId: customJobsCustomMetrics_patch
      parameters:
      - description: ID of the custom job.
        in: path
        name: customJobId
        required: true
        schema:
          type: string
      - description: ID of the custom metric.
        in: path
        name: customMetricId
        required: true
        schema:
          type: string
        x-versionadded: v2.34
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomJobCustomMetricUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCreateFromCustomJobResponse'
          description: Updated custom metric.
        '403':
          description: User does not have permission to custom jobs.
      summary: Update custom metric associated by custom job ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
  /api/v2/customJobs/{customJobId}/hostedCustomMetricTemplate/:
    get:
      description: Retrieve a template for hosted custom metric job.
      operationId: customJobsHostedCustomMetricTemplate_list
      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/HostedCustomMetricTemplateResponse'
          description: Hosted custom metric template retrieved.
        '403':
          description: User does not have permission to retrieve a custom metric test
            job.
        '404':
          description: Custom job does not exist or user does not have permission
            to access it.
      summary: Retrieve a template by custom job ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
    patch:
      description: Updates a template for hosted custom metric job.
      operationId: customJobsHostedCustomMetricTemplate_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/HostedCustomMetricTemplateUpdate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostedCustomMetricTemplateResponse'
          description: Hosted custom metric template updated.
        '403':
          description: User does not have permission to update a custom metric test
            job.
        '404':
          description: Custom job or template does not exist or user does not have
            permission to access it.
        '409':
          description: Custom job have at least 1 associated deployment.
      summary: Updates a template by custom job ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
    post:
      description: Creates a template for hosted custom metric job.
      operationId: customJobsHostedCustomMetricTemplate_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/HostedCustomMetricTemplateCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostedCustomMetricTemplateResponse'
          description: Hosted custom metric template created.
        '403':
          description: User does not have permission to create a custom metric test
            job.
        '404':
          description: Custom job does not exist or user does not have permission
            to access it.
        '409':
          description: Hosted custom metric template already exists.
      summary: Creates a template by custom job ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
  /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 by custom job ID
      tags:
      - 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: 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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 by custom job ID
      tags:
      - 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: 0
          maximum: 100
          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
            maxItems: 100
            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
            maxItems: 100
            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:
      - deployment_management
      x-versionadded: v2.24
  /api/v2/customModelDeployments/limitState/:
    get:
      description: 'Retrieve custom model deployment limit state: maximum allowed,
        current count, and whether the limit has been reached.'
      operationId: customModelDeploymentsLimitState_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelDeploymentsLimitsResponse'
          description: OK.
        '404':
          description: User not found or user does not have an organization.
      summary: Get custom model deployment limits.
      tags:
      - deployment_management
      x-versionadded: v2.42
  /api/v2/customModelDeployments/{deploymentId}/logs/:
    get:
      description: Retrieve the logs generated during deployment of the custom model.
      operationId: customModelDeploymentsLogs_list
      parameters:
      - description: The 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 by deployment ID
      tags:
      - deployment_management
      x-versionadded: v2.30
    post:
      description: Request logs from a custom deployed model.
      operationId: customModelDeploymentsLogs_create
      parameters:
      - description: The 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: Create logs by id
      tags:
      - deployment_management
      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: The ID of the custom model deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      - description: The 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: Retrieve logs by id
      tags:
      - deployment_management
      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: 0
          maximum: 1000
          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:
          type:
          - string
          - 'null'
        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
          type:
          - integer
          - 'null'
      - description: Network egress policy.
        in: query
        name: networkEgressPolicy
        required: false
        schema:
          enum:
          - NONE
          - PUBLIC
          type:
          - string
          - 'null'
      - 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
          type:
          - integer
          - 'null'
        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: 0
          maximum: 25
          type:
          - integer
          - 'null'
      - description: Require all custom model replicas to be deployed on different
          Kubernetes nodes for predictions fault tolerance.
        in: query
        name: requiresHa
        required: false
        schema:
          type:
          - boolean
          - 'null'
        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 by custom model test ID
      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 by custom model test ID
      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 by custom model test ID
      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: 0
          maximum: 1000
          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 by custom model test ID
      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: 0
          maximum: 1000
          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: The target type of the custom model.
        in: query
        name: targetType
        required: false
        schema:
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - GeoPoint
          - Unstructured
          - VectorDatabase
          - AgenticWorkflow
          - MCP
          - Multilabel
          type: string
        x-versionadded: v2.36
      - description: If TRUE, only deployed custom models will be returned. If FALSE,
          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
      - 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/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/fromModelTemplate/:
    post:
      description: Create a custom model from a template.
      operationId: customModelsFromModelTemplate_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelCreateFromTemplatePayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelCreateFromTemplateResponse'
          description: Custom model created from template
        '403':
          description: UXR Custom Model Workshop is not enabled.
        '422':
          description: Invalid template data.
      summary: Create a custom model
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables creating NVIDIA NIM models from templates in the Registry.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: NIM_MODELS
      x-versionadded: v2.36
  /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
      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.
      operationId: customModels_delete
      parameters:
      - description: The 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 by custom model ID
      tags:
      - custom_models
      x-versionadded: v2.24
    get:
      description: Retrieve metadata for a custom model.
      operationId: customModels_retrieve
      parameters:
      - description: The 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 by custom model ID
      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: The 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 by custom model ID
      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: 0
          maximum: 1000
          type: integer
      - description: The 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 by custom model ID
      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: The 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 by custom model ID
      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: The 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 by custom model ID
      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: The 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 by custom model ID
      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: 0
          maximum: 1000
          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: The 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 by custom model ID
      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: The 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 by custom model ID
      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: The 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 by custom model ID
      tags:
      - custom_models
      x-versionadded: v2.22
  /api/v2/customModels/{customModelId}/versions/fromCodespace/:
    post:
      description: Create a new custom model version with files from the codespace.
      operationId: customModelsVersionsFromCodespace_create
      parameters:
      - description: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelVersionFromCodespace'
      responses:
        '200':
          description: ''
        '202':
          description: Task for creating a new custom model version applied.
      summary: Create a new custom model version by custom model ID
      tags:
      - custom_models
      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.37
  /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: The 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 by custom model
        ID
      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: The 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 a version from a 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: The 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 by custom model ID
      tags:
      - custom_models
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      tags:
      - custom_models
      x-versionadded: v2.22
    patch:
      description: Edit metadata of a specific model version.
      operationId: customModelsVersions_patch
      parameters:
      - description: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: 0
          maximum: 1000
          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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      tags:
      - custom_models
      x-versionadded: v2.27
    get:
      description: Get a given custom model conversion.
      operationId: customModelsVersionsConversions_retrieve
      parameters:
      - description: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      tags:
      - custom_models
      x-versionadded: v2.22
    get:
      description: Retrieve the custom model version's dependency build status.
      operationId: customModelsVersionsDependencyBuild_list
      parameters:
      - description: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom
        model ID
      tags:
      - custom_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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      tags:
      - custom_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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom
        model ID
      tags:
      - custom_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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model ID
      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: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The 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 by custom model
        ID
      tags:
      - custom_models
      x-versionadded: v2.23
  /api/v2/customModels/{customModelId}/versions/{customModelVersionId}/toCodespace/:
    post:
      description: Update a codespace with files from the custom model version.
      operationId: customModelsVersionsToCodespace_create
      parameters:
      - description: The ID of the custom model.
        in: path
        name: customModelId
        required: true
        schema:
          type: string
      - description: The ID of the custom model version.
        in: path
        name: customModelVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomModelVersionToCodespace'
      responses:
        '200':
          description: ''
        '202':
          description: Task for uploading applied.
      summary: Update a codespace by custom model ID
      tags:
      - custom_models
      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.37
  /api/v2/customTasks/:
    get:
      description: 'Retrieve metadata for all accessible custom tasks.


        For more information on custom tasks, access the [UI documentation](cml-custom-tasks).'
      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: 0
          maximum: 1000
          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:
      - blueprints
      x-versionadded: v2.26
    post:
      description: 'Creates a new custom task and returns the newly created metadata
        record for it.


        A custom task may either be an estimator or a transform. Estimators must support
        a single

        target type (e.g., binary classification, regression).

        Regression and anomaly detection models are

        expected to produce predictions that are arbitrary floating-point or integer
        numbers.

        A classification model is expected to return predictions with probability
        scores for each

        class.


        Transforms are expected to return a dataframe or sparse matrix with the same
        number

        of rows as the input feature matrix. Only numeric outputs are supported

        for custom transforms.'
      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:
      - blueprints
      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:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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: 0
          maximum: 1000
          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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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: 0
          maximum: 1000
          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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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 by custom task ID
      tags:
      - blueprints
      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 a version from a repository
      tags:
      - blueprints
      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: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom task ID
      tags:
      - blueprints
      x-versionadded: v2.26
    patch:
      description: Edit metadata of a specific task version.
      operationId: customTasksVersions_patch
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom task ID
      tags:
      - blueprints
      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: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom task ID
      tags:
      - blueprints
      x-versionadded: v2.27
    get:
      description: Retrieve the custom task version's dependency build status.
      operationId: customTasksVersionsDependencyBuild_list
      parameters:
      - description: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom
        task ID
      tags:
      - blueprints
      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: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom task ID
      tags:
      - blueprints
      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: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom task
        ID
      tags:
      - blueprints
      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: The ID of the custom task.
        in: path
        name: customTaskId
        required: true
        schema:
          type: string
      - description: The 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 by custom task ID
      tags:
      - blueprints
      x-versionadded: v2.26
  /api/v2/customTemplates/:
    get:
      description: Retrieve a list of custom templates.
      operationId: customTemplates_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The order to sort the custom templates.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - name
          - -name
          - createdAt
          - -createdAt
          - templateType
          - -templateType
          - templateSubType
          - -templateSubType
          type: string
      - description: Only return custom templates whose name or description contain
          this text.
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: Only return custom templates with a matching tag.
        in: query
        name: tag
        required: false
        schema:
          type: string
      - description: Only return custom templates of this sub-type.
        in: query
        name: templateSubType
        required: false
        schema:
          type: string
      - description: Only return custom templates of this type.
        in: query
        name: templateType
        required: false
        schema:
          maxLength: 255
          type: string
      - description: Only return custom templates with this publisher.
        in: query
        name: publisher
        required: false
        schema:
          maxLength: 255
          type: string
      - description: Only return custom templates with this category (use case).
        in: query
        name: category
        required: false
        schema:
          maxLength: 255
          type: string
      - description: Hidden templates are not visible in the UI.
        in: query
        name: showHidden
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTemplateListResponse'
          description: The paginated list of custom templates.
        '403':
          description: User does not have permission to access custom templates.
      summary: Retrieve a list of custom templates.
      tags:
      - custom_applications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables Custom Templates.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_TEMPLATES
      x-versionadded: v2.36
    post:
      description: Create a custom template.
      operationId: customTemplates_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTemplateCreatePayload'
      responses:
        '201':
          description: The custom template was successfully created.
        '403':
          description: User does not have permission to create a custom template.
      summary: Create a custom template.
      tags:
      - custom_applications
      x-versionadded: v2.36
  /api/v2/customTemplates/{customTemplateId}/:
    delete:
      description: Delete a custom template.
      operationId: customTemplates_delete
      parameters:
      - description: The ID of the custom template.
        in: path
        name: customTemplateId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The requested custom template was successfully deleted.
        '403':
          description: User does not have permission to delete a custom template.
        '404':
          description: Custom template was not found.
      summary: Delete a custom template by custom template ID
      tags:
      - custom_applications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables Custom Templates.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_TEMPLATES
      x-versionadded: v2.36
    get:
      description: Retrieve a single custom template.
      operationId: customTemplates_retrieve
      parameters:
      - description: The ID of the custom template.
        in: path
        name: customTemplateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTemplateEntity'
          description: A given custom template.
        '403':
          description: User does not have permission to access a particular custom
            template.
      summary: Retrieve a single custom template by custom template ID
      tags:
      - custom_applications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables Custom Templates.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_TEMPLATES
      x-versionadded: v2.36
    patch:
      description: Update the given custom template.
      operationId: customTemplates_patch
      parameters:
      - description: The ID of the custom template.
        in: path
        name: customTemplateId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomTemplateUpdatePayload'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTemplateEntity'
          description: The custom template was successfully updated.
        '403':
          description: User does not have permission to update a custom template.
      summary: Update the given custom template by custom template ID
      tags:
      - custom_applications
      x-versionadded: v2.36
  /api/v2/customTemplates/{customTemplateId}/files/{fileId}/:
    get:
      description: Retrieve a single custom template file.
      operationId: customTemplatesFiles_retrieve
      parameters:
      - description: The ID of the custom template.
        in: path
        name: customTemplateId
        required: true
        schema:
          type: string
      - description: The ID of the file.
        in: path
        name: fileId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTemplateFileResponse'
          description: A given custom template file.
        '403':
          description: User does not have permission to access a particular custom
            template file.
        '404':
          description: File not found.
      summary: Retrieve a single custom template file by custom template ID
      tags:
      - custom_applications
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables Custom Templates.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_TEMPLATES
      x-versionadded: v2.38
  /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: 0
          maximum: 1000
          type: integer
      - description: 'The list of 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
            - GeoPoint
            - Unstructured
            - VectorDatabase
            - AgenticWorkflow
            - MCP
            - Multilabel
            type: string
          maxItems: 12
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomTrainingBlueprintListResponse'
          description: Custom training blueprint list returned.
      summary: List training blueprints.
      tags:
      - blueprints
      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
      tags:
      - blueprints
      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:
      - data_registry
      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  by ID
      tags:
      - data_registry
      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:
      - data_registry
      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
      tags:
      - data_registry
      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 by workspace state ID
      tags:
      - data_registry
      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
      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 by data slice ID
      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 by data slice ID
      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
          - vectorDatabase
          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:
          type:
          - string
          - 'null'
      - 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:
          type:
          - string
          - 'null'
      - 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 by
        data slice ID
      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 by
        data slice ID
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/dataStages/:
    post:
      description: Create a data stage.
      operationId: dataStages_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataStageRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataStageResponse'
          description: Created data stage
        '403':
          description: Permission denied.
        '422':
          description: The request cannot be processed.
      summary: Create a data stage
      tags:
      - data_connectivity
      x-versionadded: v2.35
  /api/v2/dataStages/{dataStageId}/finalize/:
    post:
      description: Finalize a data stage.
      operationId: dataStagesFinalize_create
      parameters:
      - description: The ID of the data stage.
        in: path
        name: dataStageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStageFinalizeResponse'
          description: Finalize data stage
        '403':
          description: Permission denied.
        '404':
          description: The entity is not found.
        '406':
          description: The request is not acceptable.
        '409':
          description: The request conflicts with the server state.
        '410':
          description: The requested entity has been deleted.
        '422':
          description: The request cannot be processed.
      summary: Finalize a data stage by data stage ID
      tags:
      - data_connectivity
      x-versionadded: v2.35
  /api/v2/dataStages/{dataStageId}/parts/{partNumber}/:
    put:
      description: Upload a part to the data stage.
      operationId: dataStagesParts_put
      parameters:
      - description: The ID of the data stage.
        in: path
        name: dataStageId
        required: true
        schema:
          type: string
      - description: The part number associated with the part.
        in: path
        name: partNumber
        required: true
        schema:
          maximum: 1000
          minimum: 1
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartUploadRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartUploadResponse'
          description: Upload part to a data stage
        '403':
          description: Permission denied.
        '404':
          description: The entity is not found.
        '409':
          description: The request conflicts with the server state.
        '410':
          description: The requested entity has been deleted.
        '422':
          description: The request cannot be processed.
      summary: Upload a part by data stage ID
      tags:
      - data_connectivity
      x-versionadded: v2.35
  /api/v2/datasetDefinitions/:
    get:
      description: List all dataset definitions.
      operationId: datasetDefinitions_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: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetDefPaginatedResponse'
          description: ''
      summary: List all dataset definitions
      tags:
      - dataset_definition
      x-versionadded: v2.37
    post:
      description: Create a dataset definition.
      operationId: datasetDefinitions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetDefCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetDefResponse'
          description: Dataset definition created successfully.
      summary: Create a dataset definition.
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /api/v2/datasetDefinitions/{datasetDefinitionId}/:
    delete:
      description: Soft delete a dataset definition.
      operationId: datasetDefinitions_delete
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Soft delete a dataset definition based by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
    get:
      description: Retrieve a dataset definition.
      operationId: datasetDefinitions_retrieve
      parameters:
      - description: The version of the dataset definition information.
        in: query
        name: version
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetDefResponse'
          description: ''
      summary: Retrieve a dataset definition based by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /api/v2/datasetDefinitions/{datasetDefinitionId}/analyze/:
    post:
      description: Analyze a dataset definition.
      operationId: datasetDefinitionsAnalyze_create
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Empty'
      responses:
        '204':
          description: ''
      summary: Analyze a dataset definition by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /api/v2/datasetDefinitions/{datasetDefinitionId}/chunkDefinitions/:
    get:
      description: Retrieve a list chunk definitions.
      operationId: datasetDefinitionsChunkDefinitions_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: 0
          type: integer
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChunkDefinitionPaginatedResponse'
          description: ''
      summary: Retrieve a list chunk definitions by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
    post:
      description: Create a chunk definition.
      operationId: datasetDefinitionsChunkDefinitions_create
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChunkDefinitionCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChunkDefinitionResponse'
          description: Chunk definition created successfully.
      summary: Create a chunk definition based by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /api/v2/datasetDefinitions/{datasetDefinitionId}/chunkDefinitions/{chunkDefinitionId}/:
    delete:
      description: Soft delete a chunk definition.
      operationId: datasetDefinitionsChunkDefinitions_delete
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      - description: The ID of the chunk definition.
        in: path
        name: chunkDefinitionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Soft delete a chunk definition based by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
    get:
      description: Retrieve a chunk definition.
      operationId: datasetDefinitionsChunkDefinitions_retrieve
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      - description: The ID of the chunk definition.
        in: path
        name: chunkDefinitionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChunkDefinitionResponse'
          description: ''
      summary: Retrieve a chunk definition based by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
    patch:
      description: Update a chunk definition.
      operationId: datasetDefinitionsChunkDefinitions_patch
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      - description: The ID of the chunk definition.
        in: path
        name: chunkDefinitionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChunkDefinitionRowsUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChunkDefinitionResponse'
          description: Chunk definition updated successfully.
      summary: Update a chunk definition based by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /api/v2/datasetDefinitions/{datasetDefinitionId}/chunkDefinitions/{chunkDefinitionId}/analyze/:
    post:
      description: Analyze a chunk definition.
      operationId: datasetDefinitionsChunkDefinitionsAnalyze_create
      parameters:
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      - description: The ID of the chunk definition.
        in: path
        name: chunkDefinitionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Empty'
      responses:
        '204':
          description: ''
      summary: Analyze a chunk definition by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /api/v2/datasetDefinitions/{datasetDefinitionId}/versions/:
    get:
      description: List all dataset definition versions.
      operationId: datasetDefinitionsVersions_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: 0
          type: integer
      - description: The ID of the dataset definition.
        in: path
        name: datasetDefinitionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetDefVersionPaginatedResponse'
          description: ''
      summary: List all dataset definition versions by dataset definition ID
      tags:
      - dataset_definition
      x-versionadded: v2.37
  /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
          - SAMPLE
          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:
      - data_registry
      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:
      - data_registry
      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
      tags:
      - data_registry
      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 a dataset from a data source
      tags:
      - data_registry
      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 a dataset from a file
      tags:
      - data_registry
      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 a dataset from a hdfs
      tags:
      - data_registry
      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 a dataset from a recipe
      tags:
      - data_registry
      x-versionadded: v2.33
  /api/v2/datasets/fromStage/:
    post:
      description: Create a dataset from a data stage.
      operationId: datasetsFromStage_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetFromStage'
      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
        '403':
          description: You do not have permission to use data stages.
        '404':
          description: Data Stage not found.
        '409':
          description: Data Stage not finalized
        '410':
          description: Data Stage failed
        '422':
          description: The request cannot be processed. The request did not contain
            data stage.
      summary: Create a dataset from a stage
      tags:
      - data_registry
      x-versionadded: v2.35
  /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 a dataset from an URL
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: 0
          maximum: 100
          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: The paginated list of user permissions.
      summary: List dataset access by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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
          - dataQualityIssues
          - -featureType
          - -name
          - -id
          - -unique
          - -missing
          - -stddev
          - -mean
          - -median
          - -min
          - -max
          - -dataQualityIssues
          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: The 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: Include detected data quality issue types in the response.
        in: query
        name: includeDataQuality
        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/DatasetFeaturesListResponse'
          description: A paginated list of feature info
      summary: Get dataset features by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: 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 by dataset ID
      tags:
      - features
      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: The 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 by dataset
        ID
      tags:
      - features
      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. The name
          of the top 50 key for which plot to be retrieved.
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: Use frequent values plot data instead of histogram for supported
          feature types.
        in: query
        name: usePlot2
        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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: 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 by dataset ID
      tags:
      - features
      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 by dataset
        ID
      tags:
      - features
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: The 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 by dataset ID
      tags:
      - data_registry
      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: The 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:
      - data_registry
      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: The 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 by dataset ID
      tags:
      - data_registry
      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: The 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: The 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 by dataset ID
      tags:
      - data_registry
      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  by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: The recipient type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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: 0
          maximum: 100
          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: The paginated list of user permissions.
      summary: List dataset shared roles by dataset ID
      tags:
      - data_registry
      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/CatalogSharedRoles'
      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 by dataset ID
      tags:
      - data_registry
      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
          - SAMPLE
          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 by dataset ID
      tags:
      - data_registry
      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/DatasetCreateVersionFromWorkspaceState'
      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 by dataset ID
      tags:
      - data_registry
      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 a version from a data source
      tags:
      - data_registry
      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 a version from a file
      tags:
      - data_registry
      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 a version from a hdfs
      tags:
      - data_registry
      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 a version from a latest version
      tags:
      - data_registry
      x-versionadded: v2.18
  /api/v2/datasets/{datasetId}/versions/fromRecipe/:
    post:
      description: Create a new dataset version for a specified dataset from a wrangler
        recipe.
      operationId: datasetsVersionsFromRecipe_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/DatasetCreateVersionFromRecipe'
      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
        '410':
          description: Specified recipe was already deleted.
        '422':
          description: Type of new dataset version is incompatible with specified
            dataset.
      summary: Create a version from a recipe
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/datasets/{datasetId}/versions/fromStage/:
    post:
      description: Create a new version for the specified dataset from a data stage.
      operationId: datasetsVersionsFromStage_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/DatasetFromStage'
      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
        '403':
          description: You do not have permission to use data stages.
        '404':
          description: Data Stage not found or Dataset not found
        '409':
          description: Data Stage not finalized
        '410':
          description: Data Stage failed
        '422':
          description: The request cannot be processed. Possible reasons include the
            request did not contain data stage, dataset was previously created from
            a non data stage source
      summary: Create a version from a stage
      tags:
      - data_registry
      x-versionadded: v2.35
  /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 a version from an URL
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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
          - dataQualityIssues
          - -featureType
          - -name
          - -id
          - -unique
          - -missing
          - -stddev
          - -mean
          - -median
          - -min
          - -max
          - -dataQualityIssues
          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: The 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: Include detected data quality issue types in the response.
        in: query
        name: includeDataQuality
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - 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: Retrieve all features details by id
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: 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 documents data quality log by id
      tags:
      - features
      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: The MIME type of the returned data.
              schema:
                enum:
                - text/plain
                type: string
        '404':
          description: The data quality assessment log is not available.
      summary: Retrieve file by id
      tags:
      - features
      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. The name
          of the top 50 key for which plot to be retrieved.
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: Use frequent values plot data instead of histogram for supported
          feature types.
        in: query
        name: usePlot2
        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: Retrieve feature histograms by id
      tags:
      - data_registry
      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 featurelists by id
      tags:
      - data_registry
      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: Retrieve featurelists by id
      tags:
      - data_registry
      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 file by id
      tags:
      - data_registry
      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 a version from a version
      tags:
      - data_registry
      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 by dataset ID
      tags:
      - data_registry
      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: 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_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: 0
          maximum: 100
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedDeploymentListResponse'
          description: The deleted deployments
      summary: List deleted deployments
      tags:
      - deployment_management
      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:
      - deployment_management
      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: The list of soft-deleted projects.
      summary: Retrieve the 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: The recovery operation result description.
      summary: Recover soft-deleted project by project ID
      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: 0
          maximum: 100
          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: 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
            - sapAiCore
            type: string
          type: array
        x-versionadded: v2.22
      - 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
      - description: Filters deployments by those created by the given user.
        in: query
        name: createdBy
        required: false
        schema:
          type: string
        x-versionadded: v2.34
      - description: Filter deployments by the execution type of the champion model.
        in: query
        name: championModelExecutionType
        required: false
        schema:
          enum:
          - custom_inference_model
          - external
          - dedicated
          type: string
        x-versionadded: v2.34
      - description: 'Filter deployments by the target type of the champion model.
          Example: Binary'
        in: query
        name: championModelTargetType
        required: false
        schema:
          type: string
      - description: List of tag keys to filter for. If multiple values are specified,
          deployments with tags that match any of the values will be returned.
        in: query
        name: tagKeys
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
        x-versionadded: v2.35
      - description: List of tag values to filter for. If multiple values are specified,
          deployments with tags that match any of the values will be returned.
        in: query
        name: tagValues
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
        x-versionadded: v2.35
      - description: Filter deployments by whether the deployment is an A2A agent.
          When true, returns only deployments that are A2A agents. When false, returns
          only deployments that are not A2A agents.
        in: query
        name: isA2AAgent
        required: false
        schema:
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
        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.43.0
      - description: List of tag keys. If specified, only deployments with prediction
          environments that have tags matching any of the keys will be returned.
        in: query
        name: predictionEnvironmentTagKeys
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
        x-versionadded: v2.44
      - description: List of tag values. If specified, only deployments with prediction
          environments that have tags matching any of the values will be returned.
        in: query
        name: predictionEnvironmentTagValues
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
        x-versionadded: v2.44
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentListResponse'
          description: The deployments
      summary: List deployments
      tags:
      - deployment_management
      x-versionadded: v2.17
  /api/v2/deployments/fromLearningModel/:
    post:
      description: 'Create a deployment from a DataRobot model.


        DEPRECATED in v2.37: Register the Leaderboard model with `POST /api/v2/modelPackages/fromLeaderboard/`.


        Use the following route to create a deployment `POST /api/v2/deployments/fromModelPackage/`.'
      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
      tags:
      - deployment_management
      x-versionadded: v2.17
  /api/v2/deployments/fromModelPackage/:
    post:
      description: Create a deployment from a model package.
      operationId: deploymentsFromModelPackage_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentCreateFromModelPackage'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentCreateResponse'
          description: Job submitted. The URL at the Location header can be used to
            track when the deployment is ready for predictions.
          headers:
            Location:
              description: URL for tracking async job status.
              schema:
                type: string
        '422':
          description: Unable to process the deployment creation request.
      summary: Create a deployment from a model package
      tags:
      - deployment_management
      x-versionadded: v2.37
  /api/v2/deployments/limits/:
    get:
      description: Fetch deployment limit information.
      operationId: deploymentsLimits_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentGetLimitsResponse'
          description: The deployment limits.
      summary: Get deployment limits.
      tags:
      - deployment_management
      x-versionadded: v2.43
  /api/v2/deployments/migrateDPStoServerless/:
    post:
      description: Update a deployment's prediction environment from dedicated to
        serverless.
      operationId: deploymentsMigrateDPStoServerless_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentPredictionEnvironmentUpdate'
      responses:
        '204':
          description: Deployment successfully updated.
      summary: Update a deployment's prediction environment from dedicated
      tags:
      - deployment_management
      x-versionadded: v2.38
  /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 by deployment ID
      tags:
      - deployment_management
      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 by deployment ID
      tags:
      - deployment_management
      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 by deployment ID
      tags:
      - deployment_management
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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: 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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        x-versionadded: v2.23
      - 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: Name of the metric to retrieve. Must be provided when using multiple
          modelId query params.
        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
          - MAE
          - MAPE
          - MCC
          - NPV
          - PPV
          - Poisson Deviance
          - R Squared
          - RMSE
          - RMSLE
          - Rate@Top10%
          - Rate@Top5%
          - TNR
          - TPR
          - Tweedie Deviance
          - WGS84 MAE
          - WGS84 RMSE
          type: string
      - description: ID of the model whose metric value to use as baseline.
        in: query
        name: baselineModelId
        required: false
        schema:
          type: string
        x-versionadded: v2.36
      - 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 by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.18
  /api/v2/deployments/{deploymentId}/accuracyMetrics/:
    get:
      description: Retrieve information about which accuracy metrics will be displayed
        and in what order.
      operationId: deploymentsAccuracyMetrics_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/AccuracyMetricList'
          description: Information on which accuracy metrics will be displayed and
            in what order.
        '404':
          description: Deployment not found.
      summary: Endpoint by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.36
    put:
      description: Update accuracy metrics being returned in accuracy endpoint.
      operationId: deploymentsAccuracyMetrics_putMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccuracyMetricUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccuracyMetricList'
          description: The updated accuracy metrics list.
        '404':
          description: Deployment not found.
      summary: Update deployment accuracy metrics settings by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.36
  /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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/accuracyOverSpace/:
    get:
      description: Retrieve accuracy metric baseline, and metric value calculated
        for each geospatial h3 hexagon.
      operationId: deploymentsAccuracyOverSpace_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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - description: The ID of the model for which metrics are being retrieved.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - 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
          - WGS84 MAE
          - WGS84 RMSE
          type: string
      - description: The name of the geospatial feature.
        in: query
        name: geoFeatureName
        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/AccuracyOverSpaceResponse'
          description: Accuracy over space
      summary: Retrieve accuracy over space by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.35
  /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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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
          - WGS84 MAE
          - WGS84 RMSE
          type: string
      - description: The name of the segment on which segment analysis is being performed.
        in: query
        name: segmentAttribute
        required: false
        schema:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        x-versionadded: '2.23'
      - 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 by deployment ID
      tags:
      - observability_accuracy
      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 by deployment ID
      tags:
      - observability_configuration
      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: Create a actuals from a JSON
      tags:
      - observability_configuration
      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
          - null
          type:
          - string
          - 'null'
      - 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 by deployment
        ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/agentCard/:
    delete:
      description: Delete the agent card associated with an external agent deployment.
        This operation is idempotent - returns 204 even if no agent card exists.
      operationId: deploymentsAgentCard_deleteMany
      parameters:
      - description: The ID of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '404':
          description: Deployment not found.
        '405':
          description: Agent card deletion is only allowed for external deployments.
      summary: Delete the agent card by deployment ID
      tags:
      - deployment_management
      - agent_cards
      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.44
    get:
      description: Retrieve the agent card associated with an agent deployment. The
        agent card is returned by this route as it was returned by the agent during
        deployment creation or as it was uploaded to DataRobot.
      operationId: deploymentsAgentCard_list
      parameters:
      - description: The ID of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The agent card for the deployment.
        '404':
          description: No agent card found for this deployment.
      summary: Retrieve the agent card by deployment ID
      tags:
      - deployment_management
      - agent_cards
      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.44
    put:
      description: Upload the agent card for an agent deployment. The request body
        must be the agent card document as a JSON object. If an agent card already
        exists for this deployment it will be replaced. This operation is only supported
        for external deployments. For DataRobot hosted deployments, the agent card
        document is pulled automatically from the deployment.
      operationId: deploymentsAgentCard_putMany
      parameters:
      - description: The ID of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The stored agent card for the deployment.
        '413':
          description: The agent card exceeds the maximum allowed size.
        '422':
          description: Agent card upload is only supported for external deployments.
      summary: Create by deployment ID
      tags:
      - deployment_management
      - agent_cards
      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.44
  /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: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - observability_service_health
      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 by deployment ID
      tags:
      - deployment_management
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - mitigation_challenger_models
      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 by deployment
        ID
      tags:
      - mitigation_challenger_models
      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 by deployment ID
      tags:
      - observability_custom_metrics
      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 by deployment ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/customMetrics/bulkUpload/:
    post:
      description: Bulk upload custom metric values from JSON.
      operationId: deploymentsCustomMetricsBulkUpload_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/BulkMetricValuesPayload'
      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: Bulk upload custom metric values by deployment ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.39
  /api/v2/deployments/{deploymentId}/customMetrics/fromCustomJob/:
    post:
      description: Create a deployment custom metric from an existing custom job.
      operationId: deploymentsCustomMetricsFromCustomJob_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/MetricCreateFromCustomJob'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCreateFromCustomJobResponse'
          description: Custom metric is successfully created.
        '403':
          description: User does not have permission to create a custom metric.
      summary: Create a custom metrics from a custom job
      tags:
      - observability_custom_metrics
      x-versionadded: v2.34
  /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 by deployment ID
      tags:
      - observability_custom_metrics
      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 by deployment ID
      tags:
      - observability_custom_metrics
      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 by deployment ID
      tags:
      - observability_custom_metrics
      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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - description: The name of the segment on which segment analysis is being performed.
        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: ''
          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 by deployment
        ID
      tags:
      - observability_custom_metrics
      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}/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 by deployment ID
      tags:
      - observability_custom_metrics
      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: Create a custom metrics from a JSON
      tags:
      - observability_custom_metrics
      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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - description: The name of the segment on which segment analysis is being performed.
        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: ''
          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 by deployment ID
      tags:
      - observability_custom_metrics
      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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve batch
          custom metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - 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 name of the segment on which segment analysis is being performed.
        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: ''
          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/MetricValuesOverBatchResponse'
          description: Data retrieved successfully
        '403':
          description: User does not have permission to read custom metric values.
      summary: Retrieve custom metric values over batch by deployment ID
      tags:
      - observability_custom_metrics
      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}/customMetrics/{customMetricId}/valuesOverSpace/:
    get:
      description: Retrieve custom metric values over space.
      operationId: deploymentsCustomMetricsValuesOverSpace_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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - 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/MetricValuesOverSpaceResponse'
          description: Custom metric values over space.
        '403':
          description: User does not have permission to read custom metric values.
      summary: Retrieve custom metric values over space by deployment ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.36
  /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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - description: Time duration of a bucket, default to seven days.
        in: query
        name: bucketSize
        required: false
        schema:
          default: P7D
          format: duration
          type: string
      - description: The name of the segment on which segment analysis is being performed.
        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: ''
          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 by deployment ID
      tags:
      - observability_custom_metrics
      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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - description: The name of the segment on which segment analysis is being performed.
        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: ''
          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 by deployment
        ID
      tags:
      - observability_custom_metrics
      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}/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
          type:
          - string
          - 'null'
      - description: The model ID of related champion/challenger to retrieve custom
          metric values for.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - description: The name of the segment on which segment analysis is being performed.
        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: ''
          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 by deployment
        ID
      tags:
      - observability_custom_metrics
      x-versionadded: v2.30
  /api/v2/deployments/{deploymentId}/dataQualityView/:
    get:
      description: Retrieve metadata of the data to be exported.
      operationId: deploymentsDataQualityView_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: 0
          maximum: 100
          type: integer
      - description: Start of the period of prediction data to collect. Defaults to
          a week before the end time.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: End of the period of prediction data to collect. Defaults to
          now, or a week after the start time.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The ID of the model.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The keywords to search in a predicted value, for text generation
          target types.
        in: query
        name: predictionPattern
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The keywords to search in a prompt value, for text generation
          target types.
        in: query
        name: promptPattern
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The keywords to search in an actual value, for text generation
          target types.
        in: query
        name: actualPattern
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: Field by which to order the text generation target types.
        in: query
        name: orderBy
        required: false
        schema:
          default: -timestamp
          enum:
          - timestamp
          - associationId
          - customMetrics
          - -timestamp
          - -associationId
          - -customMetrics
          type:
          - string
          - 'null'
      - description: Metric name or ID used for metric ordering.
        in: query
        name: orderMetric
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: Metric name or ID used for metric filtering.
        in: query
        name: filterMetric
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: Metric value required to match value with filter metric name.
        in: query
        name: filterValue
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataQualityResponse'
          description: ''
      summary: Retrieve metadata of the data by deployment ID
      tags:
      - observability_data_exploration
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables special storage for predicted and actual records for
          text generation target types
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MLOPS_ACTUALS_STORAGE
      - description: Enables the data quality table for text generation target types.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MMM_DATA_QUALITY
      x-versionadded: v2.35
  /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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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 by deployment ID
      tags:
      - observability_bias_fairness
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - observability_drift
      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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        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
          type:
          - string
          - 'null'
      - 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 by deployment ID
      tags:
      - observability_drift
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/featureDriftOverSpace/:
    get:
      description: Retrieve drift scores for a feature of the deployment over the
        geospatial feature data.
      feature_flags:
      - &id004
        description: Enables monitoring geospatial features.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: MMM_GEOSPATIAL_FEATURES_MONITORING
      maturity: PUBLIC_PREVIEW
      operationId: deploymentsFeatureDriftOverSpace_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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - description: The name of the geospatial feature. Segmented analysis must be
          enabled for the feature specified.
        in: query
        name: geoFeatureName
        required: false
        schema:
          type: string
      - description: The name of the feature to retrieve drift scores for. Defaults
          to the target or, if there is no target, the most important feature.
        in: query
        name: featureName
        required: false
        schema:
          type: string
      - description: The ID of the model that feature drift is being retrieved from.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - description: The metric used to calculate drift score.
        in: query
        name: metric
        required: false
        schema:
          default: psi
          enum:
          - psi
          - klDivergence
          - dissimilarity
          - hellinger
          - jsDivergence
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      public_preview: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureDriftOverSpaceResponse'
          description: The retrieved drift scores for the specified feature over the
            specified geospatial feature data.
      summary: Retrieve feature drift scores over space through geospatial monitoring
        by deployment ID
      tags:
      - observability_drift
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id004
  /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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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:
          type:
          - string
          - 'null'
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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 by deployment ID
      tags:
      - observability_drift
      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: The sort order to apply to the list of features. 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
          type: string
        x-versionadded: v2.35
      - 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
      summary: Get deployment features by deployment ID
      tags:
      - deployment_management
      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 by deployment ID
      tags:
      - deployment_configuration
      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 by deployment ID
      tags:
      - deployment_configuration
      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 by deployment ID
      tags:
      - deployment_configuration
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - mitigation_humility
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - mitigation_humility
      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 by deployment ID
      tags:
      - deployment_model_replacement
      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 by deployment ID
      tags:
      - deployment_configuration
      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 by deployment ID
      tags:
      - deployment_configuration
      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 by deployment ID
      tags:
      - deployment_configuration
      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 by deployment ID
      tags:
      - deployment_model_replacement
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/modelHistory/:
    get:
      description: Retrieve champion model history of deployment.
      operationId: deploymentsModelHistory_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: 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/ModelHistoryListResponse'
          description: List of deployment model history.
      summary: Retrieve champion model history of deployment by deployment ID
      tags:
      - deployment_management
      x-versionadded: v2.36
  /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 by deployment ID
      tags:
      - observability_batch_monitoring
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/monitoringBatches/:
    get:
      description: List monitoring batches in a deployment.
      operationId: deploymentsMonitoringBatches_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_batch_monitoring
      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: The 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: 0
          maximum: 100
          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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_batch_monitoring
      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 by deployment ID
      tags:
      - observability_configuration
      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 by deployment ID
      tags:
      - deployment_management
      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: 0
          maximum: 100
          type: integer
      - description: A prediction data export processing state.
        in: query
        name: status
        required: false
        schema:
          default: null
          enum:
          - CANCELLED
          - CREATED
          - FAILED
          - SCHEDULED
          - SUCCEEDED
          - null
          type:
          - string
          - 'null'
      - description: Id of model used for prediction data export.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - 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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - tracking_agent
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/predictionResults/:
    get:
      description: Retrieve predictions results of the deployment.
      operationId: deploymentsPredictionResults_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by deployment ID
      tags:
      - observability_data_exploration
      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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        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, location 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 by deployment ID
      tags:
      - observability_drift
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/predictionsOverSpace/:
    get:
      description: Retrieve predictions stats for the deployment over the geospatial
        feature data.
      feature_flags:
      - &id005
        description: Enables monitoring geospatial features.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: MMM_GEOSPATIAL_FEATURES_MONITORING
      maturity: PUBLIC_PREVIEW
      operationId: deploymentsPredictionsOverSpace_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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - description: The name of the geospatial feature. Segmented analysis must be
          enabled for the feature specified.
        in: query
        name: geoFeatureName
        required: false
        schema:
          type: string
      - description: The ID of the model that feature drift is being retrieved from.
        in: query
        name: modelId
        required: false
        schema:
          type: string
      - 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, location 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
      public_preview: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionsOverSpaceResponse'
          description: The retrieved prediction stats for the specified feature over
            the specified geospatial feature data.
      summary: Retrieve predictions stats over space through geospatial monitoring
        by deployment ID
      tags:
      - observability_drift
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id005
  /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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        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, location 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 by deployment ID
      tags:
      - observability_drift
      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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        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 & by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/predictionsVsActualsOverSpace/:
    get:
      description: Retrieve predictions vs. actuals over space.
      operationId: deploymentsPredictionsVsActualsOverSpace_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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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 the geospatial feature.
        in: query
        name: geoFeatureName
        required: false
        schema:
          type: string
      - 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/PredictionsVsActualsOverSpaceResponse'
          description: Predictions vs. actuals over space.
      summary: Retrieve predictions vs by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.35
  /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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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:
          type:
          - string
          - 'null'
        x-versionadded: v2.20
      - description: The value of the `segmentAttribute` to segment on.
        in: query
        name: segmentValue
        required: false
        schema:
          default: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - observability_accuracy
      x-versionadded: v2.32
  /api/v2/deployments/{deploymentId}/quotaConsumers/:
    get:
      description: Retrieve list of unique agents/users that have made requests to
        this deployment. Only available to deployment owners and users with read permissions.
      operationId: deploymentsQuotaConsumers_list
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deployment consumer information retrieved.
      summary: Retrieve deployment consumers by deployment ID
      tags:
      - deployment_management
      x-versionadded: v2.4
  /api/v2/deployments/{deploymentId}/retrainingPolicies/:
    get:
      description: Retrieve a list of deployment retraining policies.
      operationId: deploymentsRetrainingPolicies_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by deployment ID
      tags:
      - mitigation_retraining
      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: Create retraining policies by id
      tags:
      - mitigation_retraining
      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: Delete retraining policies by id
      tags:
      - mitigation_retraining
      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: Retrieve retraining policies by id
      tags:
      - mitigation_retraining
      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: Modify retraining policies by id
      tags:
      - mitigation_retraining
      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: The 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: 0
          maximum: 1000
          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: Retrieve runs by id
      tags:
      - mitigation_retraining
      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: Create runs by id
      tags:
      - mitigation_retraining
      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: Retrieve runs by id
      tags:
      - mitigation_retraining
      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: Modify runs by id
      tags:
      - mitigation_retraining
      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: Retrieve retraining settings by id
      tags:
      - mitigation_retraining
      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: Modify retraining settings by id
      tags:
      - mitigation_retraining
      x-versionadded: v2.29
  /api/v2/deployments/{deploymentId}/runtimeParameters/:
    get:
      description: List runtime parameters.
      feature_flags:
      - &id006
        description: Enables the ability to edit Custom Model Runtime-Parameters (and
          replica and resource bundle settings) directly from the Deployment info
          page. Edited values are local to a given Deployment and do not affect the
          runtime of any current or future Deployments of the same Model Package.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT
      maturity: PUBLIC_PREVIEW
      operationId: deploymentsRuntimeParameters_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: 'The sort order to apply to the runtime parameters list. Prefix
          the attribute name with a dash to sort in descending order; for example:
          ''-created_at''.'
        in: query
        name: orderBy
        required: true
        schema:
          default: name
          enum:
          - createdAt
          - -createdAt
          - name
          - -name
          type: string
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      public_preview: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeParameterListResponse'
          description: ''
      summary: List runtime parameters by deployment ID
      tags:
      - deployment_runtime_parameters
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id006
    put:
      description: Update runtime parameters by replacing existing params with the
        provided set. Any values not provided will revert back to the values set from
        the model package.
      feature_flags:
      - &id007
        description: Enables the ability to edit Custom Model Runtime-Parameters (and
          replica and resource bundle settings) directly from the Deployment info
          page. Edited values are local to a given Deployment and do not affect the
          runtime of any current or future Deployments of the same Model Package.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: CUSTOM_MODEL_EDIT_RUNTIME_PARAMETERS_ON_DEPLOYMENT
      maturity: PUBLIC_PREVIEW
      operationId: deploymentsRuntimeParameters_putMany
      parameters:
      - description: Unique identifier of the deployment.
        in: path
        name: deploymentId
        required: true
        schema:
          type: string
      public_preview: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuntimeParameterUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeParameterListResponse'
          description: ''
      summary: Update runtime parameters by deployment ID
      tags:
      - deployment_runtime_parameters
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id007
  /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 by deployment ID
      tags:
      - deployment_management
      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 by deployment ID
      tags:
      - deployment_management
      x-versionadded: v2.23
  /api/v2/deployments/{deploymentId}/segmentAttributes/:
    get:
      description: Retrieve deployment segment attributes.
      operationId: deploymentsSegmentAttributes_list
      parameters:
      - description: The monitoring type for which segment attributes are being retrieved.
        in: query
        name: monitoringType
        required: false
        schema:
          default: serviceHealth
          enum:
          - serviceHealth
          - dataDrift
          - accuracy
          - humility
          - customMetrics
          - geospatial
          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/SegmentAttributesRetrieveResponse'
          description: ''
      summary: Retrieve Segment attributes by id
      tags:
      - observability_configuration
      x-versionadded: v2.35
  /api/v2/deployments/{deploymentId}/segmentValues/:
    get:
      description: Retrieve deployment segment values.
      operationId: deploymentsSegmentValues_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: The name of the segment attribute whose values the user wants
          to retrieve.
        in: query
        name: segmentAttribute
        required: false
        schema:
          default: DataRobot-Consumer
          type: string
      - description: The search query to filter the list of segment values.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          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/SegmentValuesRetrieveResponse'
          description: ''
      summary: Retrieve Segment values by id
      tags:
      - observability_configuration
      x-versionadded: v2.35
  /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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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: ''
          type:
          - string
          - 'null'
        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/ServiceStatsForTimeRangeResponse'
          description: Service health metric data retrieved.
      summary: Retrieve service stats by id
      tags:
      - observability_service_health
      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: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - observability_service_health
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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 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: ''
          type:
          - string
          - 'null'
        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: 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: 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 by deployment ID
      tags:
      - observability_service_health
      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
      summary: Retrieve deployment settings by deployment ID
      tags:
      - deployment_configuration
      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: A url that can be polled to check the status.
              schema:
                type: string
      summary: Update deployment settings by deployment ID
      tags:
      - deployment_configuration
      x-versionadded: v2.17
  /api/v2/deployments/{deploymentId}/settings/checklist/:
    get:
      description: Return a checklist of deployment settings indicating which settings
        are configured and which are not.
      operationId: deploymentsSettingsChecklist_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/DeploymentChecklistResponse'
          description: The deployment settings checklist
      summary: Retrieve deployment settings checklist by deployment ID
      tags:
      - deployment_management
      x-versionadded: v2.38
  /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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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 the model deployment access control list by deployment ID
      tags:
      - deployment_management
      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 the model deployment access controls by deployment ID
      tags:
      - deployment_management
      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 by deployment ID
      tags:
      - deployment_management
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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: ''
          type:
          - string
          - 'null'
        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 by deployment ID
      tags:
      - observability_drift
      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: 0
          maximum: 20
          type: integer
      - description: ID of model used for training data export.
        in: query
        name: modelId
        required: false
        schema:
          default: null
          type:
          - string
          - 'null'
      - 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: The list of training data exports by deployment ID
      tags:
      - observability_data_exploration
      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 by deployment ID
      tags:
      - observability_data_exploration
      x-versionadded: v2.33
  /api/v2/deployments/{deploymentId}/trainingDataExports/{exportId}/:
    get:
      description: Retrieve details for a single training data export.
      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 details by deployment ID
      tags:
      - observability_data_exploration
      x-versionadded: v2.33
  /api/v2/entitlements/applyEntitlementSets/:
    post:
      description: Request temporary entitlement leases for users within a tenant.
      operationId: entitlementsApplyEntitlementSets_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyEntitlementSetLeaseRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementSetLeaseResponse'
          description: Entitlement leases applied successfully.
        '400':
          description: Invalid request data.
        '403':
          description: Access denied.
        '422':
          description: Invalid parameters provided.
        '500':
          description: Service temporarily unavailable.
      summary: Apply entitlement set leases.
      tags:
      - entitlements
      x-versionadded: v2.38
  /api/v2/entitlements/entitlementSetLeases/:
    get:
      description: Retrieve entitlement set leases with optional filtering by tenant,
        entitlement set, and status.
      operationId: entitlementsEntitlementSetLeases_list
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntitlementSetLeasesRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitlementSetLeasesResponse'
          description: Entitlement set leases retrieved successfully.
        '400':
          description: Invalid request parameters.
        '403':
          description: Access denied.
        '500':
          description: Service temporarily unavailable.
      summary: Retrieve entitlement set leases.
      tags:
      - entitlements
      x-versionadded: v2.38
  /api/v2/entitlements/evaluate/:
    post:
      description: Evaluate entitlements of the client requesting the API.
      operationId: entitlementsEvaluate_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluateEntitlementsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateEntitlementsResponse'
          description: Evaluation succeeded.
      summary: Evaluate entitlements.
      tags:
      - entitlements
      x-versionadded: v2.35
  /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: The entity notification channel was created successfully.
      summary: Create an entity notification channel.
      tags:
      - notifications
      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: The number of notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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 the related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationChannelsListResponse'
          description: The entity notification channels were listed successfully.
      summary: List notification channels related by relatedentitytype
      tags:
      - notifications
      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 the related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '204':
          description: The entity notification channel was deleted successfully.
      summary: Delete an entity notification channel by relatedentitytype
      tags:
      - notifications
      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 the related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationChannelResponse'
          description: Entity notification channel retrieved successfully.
      summary: Retrieve an entity notification channel by relatedentitytype
      tags:
      - notifications
      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 the related entity.
        in: path
        name: relatedEntityId
        required: true
        schema:
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationChannelWithDREntityUpdate'
      responses:
        '204':
          description: The entity notification channel was updated successfully.
        '400':
          description: Email verification code is invalid.
      summary: Update an entity notification channel by relatedentitytype
      tags:
      - notifications
      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 an entity notification policy.
      tags:
      - notifications
      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: 0
          maximum: 1000
          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
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPoliciesListResponse'
          description: Entity notification policies listed successfully.
      summary: List entity notification policies by relatedentitytype
      tags:
      - notifications
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '204':
          description: Entity notification policy deleted successfully.
      summary: Delete an entity notification policy by relatedentitytype
      tags:
      - notifications
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyResponse'
          description: Entity notification policy retrieved successfully.
      summary: Retrieve an entity notification policy by relatedentitytype
      tags:
      - notifications
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyUpdate'
      responses:
        '204':
          description: Entity notification policy updated successfully.
      summary: Update an entity notification policy by relatedentitytype
      tags:
      - notifications
      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 an entity notification policy
      tags:
      - notifications
      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 an entity notification policy template.
      tags:
      - notifications
      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: 0
          maximum: 1000
          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
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - insights_computation.all
          - notebook_schedule.all
          - monitoring.all
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPoliciesTemplatesListResponse'
          description: Entity notification policies templates listed successfully.
      summary: List entity notification policy templates by relatedentitytype
      tags:
      - notifications
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '204':
          description: Entity notification policy template deleted successfully.
      summary: Delete an entity notification policy template by relatedentitytype
      tags:
      - notifications
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNotificationPolicyTemplateResponse'
          description: Entity notification policy template retrieved successfully.
      summary: Retrieve an entity notification policy template by relatedentitytype
      tags:
      - notifications
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityNotificationPolicyTemplateUpdate'
      responses:
        '204':
          description: Entity notification policy template updated successfully.
      summary: Update an entity notification policy template by relatedentitytype
      tags:
      - notifications
      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: 0
          maximum: 1000
          type: integer
      - description: The ID of the notification policy template.
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          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 by relatedentitytype
      tags:
      - notifications
      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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The ID of the notification policy template.
        in: path
        name: policyId
        required: true
        schema:
          type: string
      - description: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The registered model 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 the registered model access control list by relatedentitytype
      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: The type of the related entity.
        in: path
        name: relatedEntityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdate'
      responses:
        '204':
          description: The roles were 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 the registered model controls by relatedentitytype
      tags:
      - notifications
      x-versionadded: v2.33
  /api/v2/entityTags/:
    get:
      description: Retrieve the list of entity tags.
      operationId: entityTags_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: 0
          maximum: 100
          type: integer
      - description: Returns only Entity Tags with names that match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Returns only Entity Tags with entityType that match the given
          type.
        in: query
        name: entityType
        required: false
        schema:
          enum:
          - experiment_container
          type: string
      - description: The order in which to return entity tags.
        in: query
        name: orderBy
        required: true
        schema:
          default: id
          enum:
          - -entityType
          - -id
          - -name
          - entityType
          - id
          - name
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityTagListResponse'
          description: Entity tags retrieved successfully.
        '403':
          description: User does not have access to this functionality.
      summary: Retrieve the list of entity tags.
      tags:
      - entity_tags
      x-versionadded: v2.36
    post:
      description: Look up an entity tag.
      operationId: entityTags_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityTagCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityTagResponse'
          description: The entity tag.
        '201':
          description: The tag was successfully created.
        '422':
          description: Unprocessable Entity
      summary: Get entity tag.
      tags:
      - entity_tags
      x-versionadded: v2.36
  /api/v2/entityTags/{entityTagId}/:
    delete:
      description: Delete an entity tag.
      operationId: entityTags_delete
      parameters:
      - description: The ID of the entity tag.
        in: path
        name: entityTagId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Delete an entity tag by entity tag ID
      tags:
      - entity_tags
      x-versionadded: v2.36
    patch:
      description: Update an entity tag.
      operationId: entityTags_patch
      parameters:
      - description: The ID of the entity tag.
        in: path
        name: entityTagId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EntityTagUpdate'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityTagResponse'
          description: The entity tag has been successfully updated.
        '403':
          description: User does not have access to this functionality.
        '404':
          description: Tag not found.
        '422':
          description: Unprocessable Entity
      summary: Update entity tag by entity tag ID
      tags:
      - entity_tags
      x-versionadded: v2.36
  /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:
          - ACL synchronization cycle completed
          - ACL synchronized for a connector
          - 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
          - AZURE OAuth Failed
          - AZURE OAuth Token Obtained
          - AZURE OAuth Token Renewal Succeeded
          - AZURE OAuth User Login Started
          - AZURE OAuth User Login Succeeded
          - 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
          - App Template Cloned
          - App Template Created
          - App Template Deleted
          - App Template Media Deleted
          - App Template Media Uploaded
          - App Template Updated
          - 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
          - Automatic Time Series Task Plan 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
          - Branded Theme Created
          - Branded Theme Deleted
          - Branded Theme Updated
          - 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 Review Requested
          - Change Request Updated
          - Change password
          - Clustering Cluster Names Updated
          - Code Snippet Created
          - 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
          - Completed Relationship Quality Assessment
          - 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 Memory
          - Create Memory Agent
          - Create Memory Event
          - Create Memory Session
          - Create Memory Space
          - 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 Managed Image Created
          - Custom Application Published
          - Custom Application Renamed
          - Custom Application Shared with Group
          - Custom Application Shared with Organization
          - Custom Application Shared with User
          - Custom Application Source Access Revoked from the Group
          - Custom Application Source Access Revoked from the Organization
          - Custom Application Source Access Revoked from the User
          - Custom Application Source Shared with Group
          - Custom Application Source Shared with Organization
          - Custom Application Source Shared with User
          - Custom Application Started
          - Custom Application Stopped
          - Custom Application Usage Exported
          - Custom Application Visited
          - Custom Application Visited by Guest
          - Custom Job Run Cancelled
          - Custom Job Run Executed
          - Custom Job Run Failed
          - Custom Job Run Interrupted
          - Custom Job Run Succeeded
          - 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 Model Updated from Codespace
          - Custom Model Version Uploaded to Codespace
          - 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 inference model version created from remote repository content
          - Custom model item added
          - Custom model item created from template
          - 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 Created from Recipe
          - 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 Memories Bulk
          - Delete Memory
          - Delete SAML configuration
          - Delete existing Memory Space
          - 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 Predictions Data 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 Lease Created
          - Entitlement Set Lease Deleted
          - Entitlement Set Lease Updated
          - Entitlement Set Updated
          - Entitlement Set Updated Entitlements
          - Entity Notification Channel Created
          - Entity Notification Channel Deleted
          - Entity Notification Channel Updated
          - Entity Notification Policy Created
          - Entity Notification Policy Deleted
          - Entity Notification Policy Updated
          - Entity Tag Created
          - Entity Tag Deleted
          - Entity Tag Updated
          - 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 Application Created
          - External Application Deleted
          - External Application Updated
          - External Predictions Configured
          - External Registered Model Created
          - External Registered Model Version Added
          - External principals synchronized for a connector
          - External token exchanged
          - FEAR Predict Job Started
          - FaaS Function Created
          - FaaS Function Deleted
          - FaaS Function Perma Deleted
          - FaaS Function Updated
          - Failed Decision Flow Test
          - Feature Discovery Relationship Quality Assessment Inputs Metrics
          - Feature Discovery Relationship Quality Assessment Warnings Metrics
          - Feature Drift Settings Changed
          - Feature Over Geo Computed
          - File Deleted
          - File Download
          - File Permadelete Executed
          - File Permadelete Failed
          - File Permadelete Submitted
          - File Shared
          - File Sharing Removed
          - File Undeleted
          - File Upload
          - File Upload is Completed
          - Finish Autopilot
          - First Login After DR Account Migration
          - GenAI Agent Chat Completion Requested
          - GenAI Chat Created
          - GenAI Chat Deleted
          - GenAI Chat Prompt Created
          - GenAI Chat Prompt Deleted
          - GenAI Chat Prompt Updated
          - GenAI Chat Updated
          - GenAI Comparison Chat Created
          - GenAI Comparison Chat Deleted
          - GenAI Comparison Chat Updated
          - GenAI Comparison Prompt Created
          - GenAI Comparison Prompt Deleted
          - GenAI Comparison Prompt Updated
          - GenAI Cost Metric Configuration Created
          - GenAI Cost Metric Configuration Deleted
          - GenAI Cost Metric Configuration Updated
          - GenAI Evaluation Dataset Configuration Created
          - GenAI Evaluation Dataset Configuration Deleted
          - GenAI Evaluation Dataset Configuration Updated
          - GenAI External Vector Database Updated
          - GenAI Insights Upserted
          - GenAI LLM Blueprint Created
          - GenAI LLM Blueprint Created from Chat Prompt
          - GenAI LLM Blueprint Created from LLM Blueprint
          - GenAI LLM Blueprint Deleted
          - GenAI LLM Blueprint Sent to Model Workshop
          - GenAI LLM Blueprint Updated
          - GenAI LLM Test Configuration Created
          - GenAI LLM Test Configuration Deleted
          - GenAI LLM Test Configuration Updated
          - GenAI LLM Test Result Created
          - GenAI LLM Test Result Deleted
          - GenAI LLM Test Result Updated
          - GenAI LLM Test Suite Created
          - GenAI LLM Test Suite Deleted
          - GenAI LLM Test Suite Updated
          - GenAI Metrics Transferred to Model Workshop
          - GenAI Moderation Config Saved
          - GenAI Moderation Model Deployed
          - GenAI Playground Created
          - GenAI Playground Deleted
          - GenAI Playground Trace Exported
          - GenAI Playground Updated
          - GenAI Prompt Template Created
          - GenAI Prompt Template Deleted
          - GenAI Prompt Template Version Created
          - GenAI Vector Database Created
          - GenAI Vector Database Deleted
          - GenAI Vector Database Downloaded
          - GenAI Vector Database Exported
          - GenAI Vector Database Updated
          - 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 Inbound OAuth Configuration Created
          - Global Inbound OAuth Configuration Updated
          - 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
          - Inbound OAuth Configuration Created
          - Inbound OAuth Configuration Updated
          - Incremental Learning Model 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
          - MCP tool is called
          - 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
          - Memory Events List Requested
          - Memory Executor Run Completed
          - Memory Session Delete Requested
          - Memory Sessions List Requested
          - Memory Vector Store Delete
          - Memory Vector Store Insert
          - Memory Vector Store Reset
          - Memory Vector Store Update
          - Model Deployment Access Revoked
          - Model Deployment Shared
          - Model Insights Deleted
          - 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 Conversion to Codespace Complete
          - Notebook Conversion to Codespace Initiated
          - 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 Ports Created
          - Notebook Session Ports Deleted
          - Notebook Session Ports Updated
          - Notebook Session Started
          - Notebook Session Stopped
          - Notification Channel Deleted
          - Notification Channel Template Created
          - Notification Channel Template Deleted
          - 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.
          - OAuth Provider Access Token Generated
          - OAuth Provider Authorization Created
          - OAuth Provider Authorization Revoked
          - OCR Job Resource Completed
          - OCR Job Resource Created
          - OCR Job Resource Started
          - OIDC Configuration Created
          - OIDC Configuration Deleted
          - OIDC Configuration Updated
          - OTel Logs reset
          - OTel Metrics reset
          - OTel Tracing reset
          - 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 Operations Added
          - 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
          - Remote Repository Registered
          - Replaced Model
          - Request External Insights
          - Request External Insights - All Datasets
          - Request Model Insights
          - Reset Memories
          - 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
          - SCIM Configuration Updated
          - 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
          - Tracing Dependency Graph Requested
          - Tracing List Requested
          - Tracing Span Histogram Requested
          - Train Model
          - Trial Account Provisioning Completed
          - Trial Account Provisioning Failed
          - Trial Account Provisioning Started
          - Unsupervised Mode Started
          - Update Memory
          - Update SAML configuration
          - Update account
          - Update existing Memory Space
          - Update existing chat history event
          - 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 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: The 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: The list of events.
      summary: Retrieve all the available events
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/eventLogs/predictionUsage/:
    get:
      description: Retrieve prediction usage data. The ``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: The list of prediction events.
      summary: Retrieve prediction usage data.
      tags:
      - analytics
      x-versionadded: v2.17
  /api/v2/eventLogs/{recordId}/:
    get:
      description: Get the 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 the audit record by ID by record ID
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/executionEnvironments/:
    get:
      description: List all execution environments sorted by creation time descending.
      operationId: executionEnvironments_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: 0
          maximum: 1000
          type: integer
      - description: String to search for occurence in all execution environment's
          description and label. Search is case insensitive. If not specified, all
          execution environments will be returned.
        in: query
        name: searchFor
        required: false
        schema:
          maxLength: 10000
          type: string
      - description: If specified, only execution environments with this use case
          are returned.
        in: query
        name: useCases
        required: false
        schema:
          enum:
          - customModel
          - notebook
          - gpu
          - customApplication
          - sparkApplication
          - customJob
          type: string
        x-versionadded: v2.36
      - description: If set, only return execution environments matching this setting.
        in: query
        name: isPublic
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentListResponse'
          description: The request was successful.
      summary: List execution environments.
      tags:
      - custom_models
      x-versionadded: v2.36
    post:
      description: Create a new execution environment.
      operationId: executionEnvironments_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentCreateResponse'
          description: The new environment has been successfully created.
          headers:
            Location:
              description: URL from which the new environment can be retrieved.
              schema:
                type: string
        '409':
          description: An environment with the supplied ID already exists
        '422':
          description: User does not have permission to create legacy conversion environment
      summary: Create an execution environment.
      tags:
      - custom_models
      x-versionadded: v2.36
  /api/v2/executionEnvironments/{environmentId}/:
    delete:
      description: Mark a specified execution environment as deleted. Environments
        are never deleted from database, however marked environments don't appear
        in any API. Relevant CustomModelImage will be deleted.
      operationId: executionEnvironments_delete
      parameters:
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The execution environment has been successfully deleted.
        '409':
          description: This environment is currently deployed and cannot be deleted.
            The response body will contain link where those deployments can be retrieved.
      summary: Destroy an execution environment by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
    get:
      description: Retrieve a single execution environment.
      operationId: executionEnvironments_retrieve
      parameters:
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentResponse'
          description: The request was successful.
      summary: Get an execution environment by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
    patch:
      description: Update an execution environment.
      operationId: executionEnvironments_patch
      parameters:
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentResponse'
          description: The execution environment has been successfully updated.
      summary: Update an execution environment by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
  /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 by environment ID
      tags:
      - custom_models
      - deployment_management
      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 by environment ID
      tags:
      - custom_models
      - deployment_management
      x-versionadded: v2.25
  /api/v2/executionEnvironments/{environmentId}/versions/:
    get:
      description: List all execution environment versions sorted by creation time
        descending.
      operationId: executionEnvironmentsVersions_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: 0
          maximum: 1000
          type: integer
      - description: Build status of execution environment version to filter. If not
          specified, all versions will be returned.
        in: query
        name: buildStatus
        required: false
        schema:
          enum:
          - submitted
          - processing
          - failed
          - success
          - aborted
          type: string
      - description: String to search for occurrence in execution environment versions
          by version id, image_id,  search in label and description. Search is case
          insensitive.If not specified, all execution environment versions will be
          returned.
        in: query
        name: search
        required: false
        schema:
          maxLength: 100
          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/ExecutionEnvironmentVersionListResponse'
          description: The request was successful.
      summary: List execution environment versions by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
    post:
      description: Create a new execution environment version.
      operationId: executionEnvironmentsVersions_create
      parameters:
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentVersionCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentCreateResponse'
          description: The new environment version has been successfully accepted
            to be built.
          headers:
            Location:
              description: URL from which the new environment version can be retrieved.
              schema:
                type: string
        '409':
          description: An environment version with the supplied ID already exists.
      summary: Create an execution environment version by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
  /api/v2/executionEnvironments/{environmentId}/versions/{environmentVersionId}/:
    get:
      description: Retrieve an execution environment version by ID.
      operationId: executionEnvironmentsVersions_retrieve
      parameters:
      - description: The execution environment ID.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      - description: The execution environment version ID.
        in: path
        name: environmentVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentVersionResponse'
          description: The request was successful.
      summary: Get an execution environment version by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
  /api/v2/executionEnvironments/{environmentId}/versions/{environmentVersionId}/buildLog/:
    get:
      description: Retrieve execution environment version build log.
      operationId: executionEnvironmentsVersionsBuildLog_list
      parameters:
      - description: The execution environment ID.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      - description: The execution environment version ID.
        in: path
        name: environmentVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentVersionBuildLogResponse'
          description: The build log content.
        '400':
          description: Bad request.
        '404':
          description: Execution environment or execution environment version not
            found. Either the execution environment or its version does not exist
            or the user does not have permission to view the execution environment.
      summary: Download the execution environment build log by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
  /api/v2/executionEnvironments/{environmentId}/versions/{environmentVersionId}/cancelBuild/:
    patch:
      description: Stop the execution environment version build.
      operationId: executionEnvironmentsVersionsCancelBuild_patchMany
      parameters:
      - description: The execution environment ID.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      - description: The execution environment version ID.
        in: path
        name: environmentVersionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Build stopped successfully.
        '404':
          description: Execution environment or execution environment version not
            found. Either the execution environment or its version does not exist
            or the user does not have permission to view the execution environment.
        '409':
          description: Build has reached a terminal state and cannot be stopped.
      summary: Stop the execution environment build by environment ID
      tags:
      - custom_models
      x-versionadded: v2.4
  /api/v2/executionEnvironments/{environmentId}/versions/{environmentVersionId}/download/:
    get:
      description: Submit image tarball build for URI based environment.
      operationId: executionEnvironmentsVersionsDownload_list
      parameters:
      - description: If true, the built Docker image will be downloaded as a tar archive,
          otherwise the Docker context will be returned
        in: query
        name: imageFile
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      - description: The ID of the environment version.
        in: path
        name: environmentVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The download succeeded.
          headers:
            Content-Disposition:
              description: Contains an auto generated filename for this download.
              schema:
                type: string
      summary: Submit image tarball build by environment ID
      tags:
      - custom_models
      x-versionadded: v2.36
    post:
      description: Request on-demand image build for an execution environment version
        based on image URI.
      operationId: executionEnvironmentsVersionsDownload_create
      parameters:
      - description: The ID of the environment.
        in: path
        name: environmentId
        required: true
        schema:
          type: string
      - description: The ID of the environment version.
        in: path
        name: environmentVersionId
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Image build submitted
      summary: Request on-demand image build by environment ID
      tags:
      - custom_models
      x-versionadded: v2.37
  /api/v2/executionEnvironmentsPermadelete/:
    post:
      description: Permanently delete records and files associated with previously
        soft deleted execution environments.
      operationId: executionEnvironmentsPermadelete_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentPermadelete'
      responses:
        '204':
          description: ''
        '403':
          description: User does not have access to this functionality.
        '404':
          description: At least one environment was not found.
        '409':
          description: At least one environment has not been soft deleted.
      summary: Permanently delete execution environments.
      tags:
      - custom_models
      x-versionadded: v2.36
  /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
      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 by driver ID
      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 by driver ID
      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 by driver ID
      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 by driver ID
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalDataSources/:
    get:
      description: Return the detailed list of available data sources.
      operationId: externalDataSources_list
      parameters:
      - description: The 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 by data source ID
      tags:
      - data_connectivity
      x-versionadded: v2.11
    get:
      description: Return the details of the existing data source with the 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 by data source ID
      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 by data source ID
      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 the data source's access control list by data source ID
      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 the data source's access controls by data source ID
      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 by data source ID
      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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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: Retrieve shared roles by id
      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 by data source ID
      tags:
      - data_connectivity
      x-versionadded: v2.22
  /api/v2/externalDataStores/:
    get:
      description: Return the list with details of the existing data stores available
        for the user.
      operationId: externalDataStores_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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
      - description: Search for data stores whose canonicalName matches or contains
          the specified name.The search is case insensitive.
        in: query
        name: name
        required: false
        schema:
          type: string
        x-versionadded: v2.34
      - description: Specifies whether dynamic parameters in the URL will be substituted.
        in: query
        name: substituteUrlParameters
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Includes only data stores which support the specified data type
          or all data stores if set to `all`.
        in: query
        name: dataType
        required: false
        schema:
          default: all
          enum:
          - all
          - structured
          - unstructured
          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: The 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 by data store ID
      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: Specifies whether dynamic parameters in the URL will be substituted.
        in: query
        name: substituteUrlParameters
        required: false
        schema:
          default: 'False'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The 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 by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.11
    patch:
      description: Update a data store configuration.
      operationId: externalDataStores_patch
      parameters:
      - description: The 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: The updated data store entry.
      summary: Update a data store configuration by data store ID
      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: The 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 the data store's access controls by data store ID
      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: The 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: The response with array of column objects.
        '400':
          description: The 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 by data store ID
      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: The 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: 0
          maximum: 1000
          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_oauth
            - azure_sas
            - azure_service_principal
            - basic
            - bearer
            - box_jwt
            - client_id_and_secret
            - databricks_access_token_account
            - databricks_service_principal_account
            - external_oauth_provider
            - gcp
            - oauth
            - rsa
            - s3
            - sap_oauth
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_oauth
              - azure_sas
              - azure_service_principal
              - basic
              - bearer
              - box_jwt
              - client_id_and_secret
              - databricks_access_token_account
              - databricks_service_principal_account
              - external_oauth_provider
              - gcp
              - oauth
              - rsa
              - s3
              - sap_oauth
              - 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: The 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 by data store ID
      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: The 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: 0
          maximum: 1000
          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_oauth
            - azure_sas
            - azure_service_principal
            - basic
            - bearer
            - box_jwt
            - client_id_and_secret
            - databricks_access_token_account
            - databricks_service_principal_account
            - external_oauth_provider
            - gcp
            - oauth
            - rsa
            - s3
            - sap_oauth
            - snowflake_key_pair_user_account
            - snowflake_oauth_user_account
            - tableau_access_token
            type: string
          - items:
              enum:
              - adls_gen2_oauth
              - api_token
              - azure
              - azure_oauth
              - azure_sas
              - azure_service_principal
              - basic
              - bearer
              - box_jwt
              - client_id_and_secret
              - databricks_access_token_account
              - databricks_service_principal_account
              - external_oauth_provider
              - gcp
              - oauth
              - rsa
              - s3
              - sap_oauth
              - 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: The 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: The list of credentials associated with the data store.
      summary: List credentials associated by data store ID
      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: The 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 by data store ID
      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: The 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: The response with schemas and catalog.
      summary: Retrieves a data store's data schemas by data store ID
      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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The 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 the data store's access control list by data store ID
      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: The 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: The resource was 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 by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.22
  /api/v2/externalDataStores/{dataStoreId}/standardUserDefinedFunctions/:
    get:
      description: Retrieve detected standard user-defined functions. Raise a 404
        error if detection needs to be run first. Results might not be up-to-date;
        run detection with the `force=True` option to refresh them.
      operationId: externalDataStoresStandardUserDefinedFunctions_list
      parameters:
      - description: The ID of the set of credentials to use instead of username and
          password.
        in: query
        name: credentialId
        required: false
        schema:
          type: string
      - description: The standard user-defined function type.
        in: query
        name: functionType
        required: true
        schema:
          enum:
          - rolling_median
          - rolling_most_frequent
          type: string
      - description: The schema to create or detect user-defined functions in.
        in: query
        name: schema
        required: true
        schema:
          type: string
      - description: The standard user-defined function name to filter results by.
        in: query
        name: functionName
        required: false
        schema:
          type: string
      - description: The ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetectedStandardUdfsRetrieveResponse'
          description: Return detected standard user-defined functions for the given
            data store, credentials, function type, and schema.
      summary: Retrieve detected standard user-defined functions by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.36
    post:
      description: Start the creation of the standard user-defined function. Since
        this is an asynchronous process, this endpoint returns a status ID to use
        with the status endpoint as well as a location header that includes URL that
        can be polled for status. Once completed, the status URL redirects to the
        endpoint with the created function name.
      operationId: externalDataStoresStandardUserDefinedFunctions_create
      parameters:
      - description: The ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StandardUdfCreate'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusIdResponse'
          description: ''
      summary: Start a job to create a standard user-defined function of the given
        type by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.36
  /api/v2/externalDataStores/{dataStoreId}/standardUserDefinedFunctions/detect/:
    post:
      description: Start the detection process for the standard user-defined functions.
        Since this is an asynchronous process this endpoint returns a status ID to
        use with the status endpoint as well as a location header that includes the
        URL that can be polled for status. Once completed, the status URL redirects
        to the endpoint with the detected function names.
      operationId: externalDataStoresStandardUserDefinedFunctionsDetect_create
      parameters:
      - description: The ID of the data store.
        in: path
        name: dataStoreId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetectUdfs'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusIdResponse'
          description: ''
      summary: Start the job that detects standard user-defined functions for the
        given data store, credentials by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.36
  /api/v2/externalDataStores/{dataStoreId}/tables/:
    post:
      description: Retrieves a data store's database tables (including views).
      operationId: externalDataStoresTables_create
      parameters:
      - description: The 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: The list of tables available in the retrieved data store.
      summary: Retrieves a data store's database tables (including views) by data
        store ID
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/test/:
    post:
      description: Test the ability to connect to a data store with specified authentication.
      operationId: externalDataStoresTest_create
      parameters:
      - description: The 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: The outcome of the connection test.
        '400':
          description: The details on why the connect call failed.
      summary: Test data store connection by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.11
  /api/v2/externalDataStores/{dataStoreId}/verifySQL/:
    post:
      description: Execute 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: The 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: The details explaining why the SQL query is invalid.
      summary: Verify a SQL query by data store ID
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalDriverConfigurations/:
    get:
      description: Retrieve matching driver configurations based on query.
      operationId: externalDriverConfigurations_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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: The 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 by configuration ID
      tags:
      - data_connectivity
      x-versionadded: v2.19
  /api/v2/externalOAuth/authorizedProviders/:
    get:
      description: List OAuth Provider Authorizations for the user.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.AuthorizedOAuthProvidersListResponse'
          description: OK
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: List OAuth Provider Authorizations
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/authorizedProviders/{authorizedProviderId}/:
    delete:
      description: Revoke an OAuth Provider Authorization by ID.
      parameters:
      - description: OAuth Provider Authorization ID
        in: path
        name: authorizationID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: OAuth Provider Authorization not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Delete OAuth Provider Authorization by authorized provider ID
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/authorizedProviders/{authorizedProviderId}/token/:
    post:
      description: Acquire an access token for the OAuth Provider Authorization.
      parameters:
      - description: OAuth Provider Authorization ID
        in: path
        name: authorizationID
        required: true
        schema:
          type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.GetAccessTokenResponse'
          description: Created
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Forbidden operation for the given OAuth Provider
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: OAuth Provider Authorization not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Acquire OAuth Provider Authorization's Access Token by authorized provider
        ID
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/authorizedProviders/{authorizedProviderId}/userinfo/:
    get:
      description: Retrieve user information from the OAuth Provider using the previously
        obtained authorization.
      parameters:
      - description: OAuth Provider Authorization ID
        in: path
        name: authorizationID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oauth.User'
          description: User information
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Forbidden operation for the given OAuth Provider
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: OAuth Provider Authorization not found
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Authorization expired
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Get User Information by authorized provider ID
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/jobs/{jobId}/:
    get:
      description: Retrieve the status of an OAuth Provider Job by ID.
      parameters:
      - description: Job ID
        in: path
        name: jobID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.jobStatusResponse'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Job not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Get OAuth Provider Job by job ID
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/providers/:
    get:
      description: Returns a list of all available OAuth providers.
      parameters:
      - description: Filter by provider IDs
        in: query
        name: ids
        schema:
          items:
            type: string
          type: array
      - description: Filter by provider types
        in: query
        name: types
        schema:
          items:
            enum:
            - github
            - gitlab
            - bitbucket
            - google
            - box
            - microsoft
            - sharepoint
            - jira
            - confluence
            type: string
          type: array
      - description: Filter by host
        in: query
        name: host
        schema:
          items:
            type: string
          type: array
      - description: Order results by field
        in: query
        name: orderBy
        schema:
          enum:
          - createdAt
          - -createdAt
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ListOAuthProvidersResponse'
          description: OK
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: List OAuth Providers
      tags:
      - OAuth Providers
    post:
      description: Creates a new OAuth provider.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/provider.CreateProviderRequest'
        description: Create provider request body
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.OAuthProvider'
          description: Created
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Create OAuth Provider
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/providers/callback/:
    post:
      description: Handles the OAuth2 callback, exchanges authorization code for an
        access/refresh tokens, and creates a new
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handler.OAuthCallbackRequest'
        description: OAuth callback request body
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.CallbackResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Invalid authorization data was provided
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Provider not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: OAuth Provider Callback
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/providers/{providerID}/:
    delete:
      description: Initiates a job to delete an OAuth provider by its ID, along with
        all associated resources.
      parameters:
      - description: OAuth Provider ID
        in: path
        name: providerId
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.DeleteOAuthProviderResponse'
          description: Location of the job that will perform deletion
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Delete OAuth Provider by provider ID
      tags:
      - OAuth Providers
    get:
      description: Retrieves an OAuth provider by its ID.
      parameters:
      - description: OAuth Provider ID
        in: path
        name: providerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.OAuthProvider'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Provider not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Get OAuth Provider by provider ID
      tags:
      - OAuth Providers
    patch:
      description: Updates an existing OAuth provider by its ID.
      parameters:
      - description: OAuth Provider ID
        in: path
        name: providerId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/provider.UpdateProviderRequest'
              description: Update provider request body
              summary: request
        description: Update provider request body
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.OAuthProvider'
          description: OK
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Update OAuth Provider by provider ID
      tags:
      - OAuth Providers
  /api/v2/externalOAuth/providers/{providerId}/authorize/:
    post:
      description: Returns a redirect URL to the OAuth2 provider's authorization page
        to get user's consent for accessing their data.
      parameters:
      - description: OAuth Provider ID
        in: path
        name: providerId
        required: true
        schema:
          type: string
      - description: Client-supplied state to correlate the authorization request
          with the callback
        in: query
        name: state
        schema:
          type: string
      - description: Custom redirect URI which overrides the default callback URL
        in: query
        name: redirect_uri
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.AuthorizeProviderResponse'
          description: OK
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Provider not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Provider is in a conflicting state
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/httpres.ErrorResponse'
          description: Validation error
      summary: Authorize OAuth Provider by provider ID
      tags:
      - OAuth Providers
  /api/v2/files/:
    post:
      description: Create an empty files catalog item.
      operationId: files_create
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseFilesVersionResponse'
          description: The details of the created catalog item.
      summary: Create an empty files catalog item.
      tags:
      - data_registry
      x-versionadded: v2.42
  /api/v2/files/fromDataSource/:
    post:
      description: Create a files catalog item from a data source.
      operationId: filesFromDataSource_create
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FilesFromDataSource'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedFilesResponse'
          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 a files catalog item
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/fromFile/:
    post:
      description: Create a files catalog item from a file.
      operationId: filesFromFile_create
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FilesFromFile'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedFilesResponse'
          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 a file from a file
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/fromURL/:
    post:
      description: Create a files catalog item from a URL.
      operationId: filesFromURL_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilesFromUrl'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedFilesResponse'
          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 a file from an URL
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/{catalogId}/:
    delete:
      description: Marks the file with the given ID as deleted.
      operationId: files_delete
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted.
        '409':
          description: Cannot delete a dataset that has refresh jobs.
      summary: Delete the file by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/{catalogId}/allFiles/:
    delete:
      description: Recursively delete one or more files or folders inside a catalog
        item. Folder names should end with "/".
      operationId: filesAllFiles_deleteMany
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFilesOrFolders'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFilesOrFoldersResponse'
          description: ''
      summary: Delete files or folders by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.42
    get:
      description: Lists all files associated with the catalog item.
      operationId: filesAllFiles_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: If specified, will only return files that match the specified
          type(s).
        in: query
        name: fileType
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
      - description: If specified, will only return files with paths that start with
          the given folder prefix. Must end with '/'.
        in: query
        name: prefix
        required: false
        schema:
          type: string
      - description: Whether to list all files recursively. If a prefix is specific,
          whether to list all files under that prefix recursively.
        in: query
        name: recursive
        required: false
        schema:
          default: 'True'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesListResponse'
          description: The paginated list of files.
      summary: List all files associated by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.37
    patch:
      description: Rename a file or folder within the same catalog item. Folder names
        should end with "/".
      operationId: filesAllFiles_patchMany
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenameFileOrFolderBody'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesVersionResponse'
          description: ''
        '404':
          description: The specified file or folder to rename was not found in the
            catalog item.
        '422':
          description: Rename operation cannot be executed. Cannot rename a folder
            to a file path.
      summary: Rename a file by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.42
  /api/v2/files/{catalogId}/clone/:
    post:
      description: Copy all files from the original catalog item into a newly created
        one. Optionally, *omit* some files.
      operationId: filesClone_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneFiles'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesAsyncResponse'
          description: ''
      summary: Create a duplicate files collection by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/copy/:
    post:
      description: Copy a file or folder within the same catalog item. Folder names
        should end with "/".
      operationId: filesCopy_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyFileOrFolder'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesVersionResponse'
          description: ''
        '404':
          description: The specified source file or folder was not found in the catalog
            item.
        '422':
          description: Copy operation cannot be executed. Cannot copy a folder to
            a file path.
      summary: Copy a file by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.42
  /api/v2/files/{catalogId}/copyBatch/:
    post:
      description: Copy one or multiple paths across different catalog items or within
        the same catalog item.
      operationId: filesCopyBatch_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyBatch'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesAsyncResponse'
          description: ''
      summary: Copy multiple files by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/deleted/:
    patch:
      description: Recover the file item with given catalogId from `deleted`.
      operationId: filesDeleted_patchMany
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFileDeleted'
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesEmpty'
          description: The files were successfully recovered.
      summary: Recover a deleted file by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/{catalogId}/downloads/:
    post:
      description: Creates a URL to download specified data from the AI catalog (using
        either /files/{catalogId}/file/ or URL to external storage via signed URL)
        andredirects to the URL via HTTP 303.
      operationId: filesDownloads_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilesDuration'
      responses:
        '303':
          description: URL was successfully provided and 303 sent.
          headers:
            Location:
              description: Download the file by this URL.
              schema:
                type: string
      summary: Retrieve data by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/{catalogId}/file/:
    get:
      description: Retrieve the requested data from the catalog entity by streaming
        it.
      operationId: filesFile_list
      parameters:
      - description: The name of a file to download from an unstructured dataset.
          If not specified, it will download either the original archive file or,
          if there is only one file, it will download that.
        in: query
        name: fileName
        required: false
        schema:
          type: string
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
          description: The file data associated with the catalog entity.
        '422':
          description: Data cannot be downloaded. This may be because the file is
            too big to be downloaded (maximum download size depends on the configuration
            of your installation).
      summary: Retrieve the requested data by streaming it by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/{catalogId}/fromDataSource/:
    post:
      description: Add file(s) into an existing files catalog item from a data source.
      operationId: filesAddFromDataSource_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddFilesIntoContainerFromDataSource'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedFilesResponse'
          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: Add file(s) into an existing files catalog item by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.42
  /api/v2/files/{catalogId}/fromFile/:
    post:
      description: Add file(s) to an existing files catalog item.
      operationId: filesAddFromFile_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AddFilesIntoContainerFromFile'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedFilesResponse'
          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 a file from a file
      tags:
      - data_registry
      x-versionadded: v2.42
  /api/v2/files/{catalogId}/fromStage/:
    post:
      description: Add files from the *stage* into the catalog item. In the case of
        naming conflicts, rename files according to *overwrite* strategy.
      operationId: filesFromStage_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddFromStage'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesVersionResponse'
          description: ''
      summary: Apply staged files by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/fromURL/:
    post:
      description: Add file(s) into an existing files catalog item from a URL.
      operationId: filesAddFromURL_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddFilesIntoContainerFromUrl'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedFilesResponse'
          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 a file from an URL
      tags:
      - data_registry
      x-versionadded: v2.42
  /api/v2/files/{catalogId}/links/:
    post:
      description: Creates URLs to download specified data from the AI catalog (using
        either /files/{catalogId}/file/ or URL to external storage via signed URL).
      operationId: filesLinks_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilesDurationAndFiles'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedLinksResponse'
          description: URLs were successfully provided.
      summary: Create links by id
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/files/{catalogId}/sharedRoles/:
    get:
      description: Get a list of users, groups and organizations who have access to
        this entity and their roles.
      operationId: filesSharedRoles_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: The recipient type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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: 0
          maximum: 100
          type: integer
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRolesBoundedListResponse'
          description: The paginated list of user permissions.
      summary: List entity shared roles by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.45
    patch:
      description: Grant access, remove access or update roles for organizations,
        groups or users on this entity. Up to 100 roles may be set per array in a
        single request.
      operationId: filesSharedRoles_patchMany
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogSharedRoles'
      responses:
        '204':
          description: Successfully modified.
        '409':
          description: Duplicate entry for the org/group/user in permission listor
            the request would leave the entity without an owner.
        '422':
          description: Request is unprocessable. For example, `name` is stated for
            not user recipient.
      summary: Modify entity shared roles by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.45
  /api/v2/files/{catalogId}/stages/:
    post:
      description: Create an empty stage entity.
      operationId: filesStages_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesStageResponse'
          description: ''
      summary: Create an empty stage by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/stages/{stageId}/upload/:
    post:
      description: Stage file for a batch upload. This endpoint won't unzip an archive
        for you. Use `POST /files/<id>/fromFile/` (no stage) if you would like to
        unzip the archive on upload.
      operationId: filesStagesUpload_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The stage ID.
        in: path
        name: stageId
        required: true
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FileUpload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesStageResponse'
          description: ''
      summary: Stage file by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/versions/:
    get:
      description: List all versions associated with given catalogId and which match
        the specified query parameters.
      operationId: filesVersions_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: Sorting order which will be applied to catalog list.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - created
          - -created
          type: string
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogListResponse'
          description: A paginated list of catalog versions
      summary: List catalog versions by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.44
  /api/v2/files/{catalogId}/versions/{catalogVersionId}/:
    delete:
      description: Marks the file version with the given ID as deleted.
      operationId: filesVersions_delete
      parameters:
      - description: The ID of the catalog entry.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The ID of the catalog entry version.
        in: path
        name: catalogVersionId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
      summary: Delete file version by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.46
  /api/v2/files/{catalogId}/versions/{catalogVersionId}/allFiles/:
    get:
      description: List all files associated with the catalog item and version.
      operationId: filesVersionsAllFiles_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: If specified, will only return files that match the specified
          type(s).
        in: query
        name: fileType
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
      - description: If specified, will only return files with paths that start with
          the given folder prefix. Must end with '/'.
        in: query
        name: prefix
        required: false
        schema:
          type: string
      - description: Whether to list all files recursively. If a prefix is specific,
          whether to list all files under that prefix recursively.
        in: query
        name: recursive
        required: false
        schema:
          default: 'True'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The catalog version item ID.
        in: path
        name: catalogVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesListResponse'
          description: The paginated list of files.
      summary: Retrieve all files by id
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/versions/{catalogVersionId}/deleted/:
    patch:
      description: Recover the file version item with given catalogId and catalogVersionId
        from `deleted`.
      operationId: filesVersionsDeleted_patchMany
      parameters:
      - description: The ID of the catalog entry.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The ID of the catalog entry version.
        in: path
        name: catalogVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFileDeleted'
      responses:
        '200':
          description: 'The item was not deleted: nothing to recover.'
        '204':
          description: Successfully recovered
      summary: Recover deleted file version by catalog ID
      tags:
      - data_registry
      x-versionadded: v2.46
  /api/v2/files/{catalogId}/versions/{catalogVersionId}/downloads/:
    post:
      description: Creates a URL to download specified data from the AI catalog (using
        either /files/{catalogId}/versions/{catalogVersionId}/file/ or URL to external
        storage via signed URL) andredirects to the URL via HTTP 303.
      operationId: filesVersionsDownloads_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The catalog version item ID.
        in: path
        name: catalogVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilesDuration'
      responses:
        '303':
          description: URL was successfully provided and 303 sent.
          headers:
            Location:
              description: Download the file by this URL.
              schema:
                type: string
      summary: Create downloads by id
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/versions/{catalogVersionId}/file/:
    get:
      description: Retrieve the requested data from the catalog entity and version
        by streaming it.
      operationId: filesVersionsFile_list
      parameters:
      - description: The name of a file to download from an unstructured dataset.
          If not specified, it will download either the original archive file or,
          if there is only one file, it will download that.
        in: query
        name: fileName
        required: false
        schema:
          type: string
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The catalog version item ID.
        in: path
        name: catalogVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
          description: The file data associated with the catalog entity and version.
        '422':
          description: Data cannot be downloaded. This may be because the file is
            too big to be downloaded (maximum download size depends on the configuration
            of your installation).
      summary: Retrieve file by id
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/files/{catalogId}/versions/{catalogVersionId}/links/:
    post:
      description: Creates URLs to download specified data from the AI catalog (using
        either /files/{catalogId}/versions/{catalogVersionId}/file/ or URL to external
        storage via signed URL).
      operationId: filesVersionsLinks_create
      parameters:
      - description: The catalog item ID.
        in: path
        name: catalogId
        required: true
        schema:
          type: string
      - description: The catalog version item ID.
        in: path
        name: catalogVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilesDurationAndFiles'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedLinksResponse'
          description: URLs were successfully provided.
      summary: Create links by id
      tags:
      - data_registry
      x-versionadded: v2.38
  /api/v2/filesPermadeleteDryRuns/:
    post:
      description: Perform a permanent deletion dry run of an AI catalog file. Detect
        if there will be any errors or warnings. Display file versions and associated
        files that would be deleted if the deletion were executed.
      operationId: filesPermadeleteDryRuns_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilePermadelete'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilePermadeleteDryRunResponse'
          description: The dry run is complete.
        '422':
          description: Unable to permanently delete the files.
      summary: Perform a permanent deletion dry run of a file.
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/filesPermadeleteJobs/:
    post:
      description: Permanently deletes the list of files from the AI catalog.
      operationId: filesPermadeleteJobs_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilePermadelete'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilePermadeleteResponse'
          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 permanently delete the files.
      summary: Permanently delete the files.
      tags:
      - data_registry
      x-versionadded: v2.37
  /api/v2/genai/agents/fromCustomModel/{customModelId}/chat/:
    post:
      description: Create a chat completion request for an agent using a custom model.
      operationId: from_custom_model_chat_agents_fromCustomModel__customModelId__chat__post
      parameters:
      - description: The ID of a custom model to use for the chat completion.
        in: path
        name: customModelId
        required: true
        schema:
          description: The ID of a custom model to use for the chat completion.
          title: customModelId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentChatCompletionRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Request chat completion by custom model ID
      tags:
      - Agents
  /api/v2/genai/agents/fromCustomModel/{customModelId}/chat/{chatCompletionId}/:
    get:
      description: Obtain chat completion response for a given chat completion ID.
      operationId: get_chat_response_agents_fromCustomModel__customModelId__chat__chatCompletionId___get
      parameters:
      - description: The ID of a custom model to use for the chat completion.
        in: path
        name: customModelId
        required: true
        schema:
          description: The ID of a custom model to use for the chat completion.
          title: customModelId
          type: string
      - description: The ID of a chat completion object.
        in: path
        name: chatCompletionId
        required: true
        schema:
          description: The ID of a chat completion object.
          title: chatCompletionId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentChatCompletionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Obtain chat completion response by custom model ID
      tags:
      - Agents
  /api/v2/genai/chatPrompts/:
    get:
      description: List chat prompts.
      operationId: list_chat_prompts_chatPrompts__get
      parameters:
      - description: Only retrieve the chat prompts associated with this playground
          ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the chat prompts associated with this playground
            ID.
          title: playgroundId
      - description: Only retrieve the chat prompts associated with this LLM blueprint
          ID. If specified, will retrieve the chat prompts for the oldest chat in
          this LLM blueprint.
        in: query
        name: llmBlueprintId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the chat prompts associated with this LLM blueprint
            ID. If specified, will retrieve the chat prompts for the oldest chat in
            this LLM blueprint.
          title: llmBlueprintId
      - description: Only retrieve the chat prompts associated with this chat ID.
        in: query
        name: chatId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the chat prompts associated with this chat ID.
          title: chatId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChatPromptsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List chat prompts
      tags:
      - Prompting
    post:
      description: Request the execution of a new prompt within a chat or an LLM blueprint.
      operationId: create_chat_prompt_chatPrompts__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatPromptRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatPromptResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create chat prompt
      tags:
      - Prompting
  /api/v2/genai/chatPrompts/{chatPromptId}/:
    delete:
      description: Delete an existing chat prompt.
      operationId: delete_chat_prompt_chatPrompts__chatPromptId___delete
      parameters:
      - description: The ID of the chat prompt to delete.
        in: path
        name: chatPromptId
        required: true
        schema:
          description: The ID of the chat prompt to delete.
          title: chatPromptId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete chat prompt by chat prompt ID
      tags:
      - Prompting
    get:
      description: Retrieve an existing chat prompt.
      operationId: get_chat_prompt_chatPrompts__chatPromptId___get
      parameters:
      - description: The ID of the chat prompt to retrieve.
        in: path
        name: chatPromptId
        required: true
        schema:
          description: The ID of the chat prompt to retrieve.
          title: chatPromptId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatPromptResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve chat prompt by chat prompt ID
      tags:
      - Prompting
    patch:
      description: Edit an existing chat prompt.
      operationId: update_chat_prompt_data_chatPrompts__chatPromptId___patch
      parameters:
      - description: The ID of the chat prompt to edit.
        in: path
        name: chatPromptId
        required: true
        schema:
          description: The ID of the chat prompt to edit.
          title: chatPromptId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditChatPromptRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatPromptResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit chat prompt by chat prompt ID
      tags:
      - Prompting
  /api/v2/genai/chats/:
    get:
      description: List chats.
      operationId: list_chats_chats__get
      parameters:
      - description: Only retrieve the chats associated with this LLM blueprint ID.
        in: query
        name: llmBlueprintId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the chats associated with this LLM blueprint
            ID.
          title: llmBlueprintId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Apply this sort order to the results. Valid options are "name"
          and "creationDate". Prefix the attribute name with a dash to sort in descending
          order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ChatsSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name"
            and "creationDate". Prefix the attribute name with a dash to sort in descending
            order, e.g., sort=-creationDate.
          title: sort
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChatsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List chats
      tags:
      - Prompting
    post:
      description: Create a new chat.
      operationId: create_chat_chats__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create chat
      tags:
      - Prompting
  /api/v2/genai/chats/{chatId}/:
    delete:
      description: Delete an existing chat.
      operationId: delete_chat_chats__chatId___delete
      parameters:
      - description: The ID of the chat to delete.
        in: path
        name: chatId
        required: true
        schema:
          description: The ID of the chat to delete.
          title: chatId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete chat by chat ID
      tags:
      - Prompting
    get:
      description: Retrieve an existing chat.
      operationId: get_chat_chats__chatId___get
      parameters:
      - description: The ID of the chat to retrieve.
        in: path
        name: chatId
        required: true
        schema:
          description: The ID of the chat to retrieve.
          title: chatId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve chat by chat ID
      tags:
      - Prompting
    patch:
      description: Edit an existing chat.
      operationId: edit_chat_chats__chatId___patch
      parameters:
      - description: The ID of the chat to edit.
        in: path
        name: chatId
        required: true
        schema:
          description: The ID of the chat to edit.
          title: chatId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditChatRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit chat by chat ID
      tags:
      - Prompting
  /api/v2/genai/comparisonChats/:
    get:
      description: List comparison chats.
      operationId: list_comparison_chats_comparisonChats__get
      parameters:
      - description: Only retrieve the comparison chats associated with this playground
          ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the comparison chats associated with this playground
            ID.
          title: playgroundId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Apply this sort order to the results. Valid options are "name"
          and "creationDate". Prefix the attribute name with a dash to sort in descending
          order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ComparisonChatsSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name"
            and "creationDate". Prefix the attribute name with a dash to sort in descending
            order, e.g., sort=-creationDate.
          title: sort
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComparisonChatsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List comparison chats
      tags:
      - Prompting
    post:
      description: Create a new comparison chat.
      operationId: create_comparison_chat_comparisonChats__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComparisonChatRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonChatResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create comparison chat
      tags:
      - Prompting
  /api/v2/genai/comparisonChats/{comparisonChatId}/:
    delete:
      description: Delete an existing comparison chat.
      operationId: delete_comparison_chat_comparisonChats__comparisonChatId___delete
      parameters:
      - description: The ID of the comparison chat to delete.
        in: path
        name: comparisonChatId
        required: true
        schema:
          description: The ID of the comparison chat to delete.
          title: comparisonChatId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete comparison chat by comparison chat ID
      tags:
      - Prompting
    get:
      description: Retrieve an existing comparison chat.
      operationId: get_comparison_chat_comparisonChats__comparisonChatId___get
      parameters:
      - description: The ID of the comparison chat to retrieve.
        in: path
        name: comparisonChatId
        required: true
        schema:
          description: The ID of the comparison chat to retrieve.
          title: comparisonChatId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonChatResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve comparison chat by comparison chat ID
      tags:
      - Prompting
    patch:
      description: Edit an existing comparison chat.
      operationId: edit_comparison_chat_comparisonChats__comparisonChatId___patch
      parameters:
      - description: The ID of the comparison chat to edit.
        in: path
        name: comparisonChatId
        required: true
        schema:
          description: The ID of the comparison chat to edit.
          title: comparisonChatId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditComparisonChatRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonChatResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit comparison chat by comparison chat ID
      tags:
      - Prompting
  /api/v2/genai/comparisonPrompts/:
    get:
      description: List the comparison prompts associated with a comparison chat or
        a set of LLM blueprints.
      operationId: list_comparison_prompts_comparisonPrompts__get
      parameters:
      - description: Only retrieve the comparison prompts associated with the specified
          LLM blueprint IDs. Either this parameter or `comparisonChatId` must be specified,
          but not both.
        in: query
        name: llmBlueprintIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the comparison prompts associated with the specified
            LLM blueprint IDs. Either this parameter or `comparisonChatId` must be
            specified, but not both.
          title: llmBlueprintIds
      - description: Only retrieve the comparison prompts associated with the specified
          comparison chat ID. Either this parameter or `llmBlueprintIds` must be specified,
          but not both.
        in: query
        name: comparisonChatId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the comparison prompts associated with the specified
            comparison chat ID. Either this parameter or `llmBlueprintIds` must be
            specified, but not both.
          title: comparisonChatId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComparisonPromptsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List comparison prompts
      tags:
      - Prompting
    post:
      description: Request the execution of a new comparison prompt.
      operationId: create_comparison_prompt_comparisonPrompts__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComparisonPromptRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonPromptResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create comparison prompt
      tags:
      - Prompting
  /api/v2/genai/comparisonPrompts/{comparisonPromptId}/:
    delete:
      description: Delete an existing comparison prompt.
      operationId: delete_comparison_prompt_comparisonPrompts__comparisonPromptId___delete
      parameters:
      - description: The ID of the comparison prompt to delete.
        in: path
        name: comparisonPromptId
        required: true
        schema:
          description: The ID of the comparison prompt to delete.
          title: comparisonPromptId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete comparison prompt by comparison prompt ID
      tags:
      - Prompting
    get:
      description: Retrieve an existing comparison prompt.
      operationId: get_comparison_prompt_comparisonPrompts__comparisonPromptId___get
      parameters:
      - description: The ID of the comparison prompt to retrieve.
        in: path
        name: comparisonPromptId
        required: true
        schema:
          description: The ID of the comparison prompt to retrieve.
          title: comparisonPromptId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonPromptResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve comparison prompt by comparison prompt ID
      tags:
      - Prompting
    patch:
      description: Edit an existing comparison prompt. Editing may involve adding
        new prompt result metadata or executing this comparison prompt on new LLM
        blueprints.
      operationId: update_comparison_prompt_comparisonPrompts__comparisonPromptId___patch
      parameters:
      - description: The ID of the comparison prompt to edit.
        in: path
        name: comparisonPromptId
        required: true
        schema:
          description: The ID of the comparison prompt to edit.
          title: comparisonPromptId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditComparisonPromptRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                title: Response Update Comparison Prompt Comparisonprompts  Comparisonpromptid   Patch
                type: string
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit comparison prompt by comparison prompt ID
      tags:
      - Prompting
  /api/v2/genai/costMetricConfigurations/:
    post:
      description: Create a new cost metric configuration.
      operationId: create_cost_metric_configuration_costMetricConfigurations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCostMetricConfigurationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostMetricConfigurationResponse'
          description: Cost configuration created successfully
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create cost metric configuration
      tags:
      - AI Robustness Tests
  /api/v2/genai/costMetricConfigurations/{costMetricConfigurationId}/:
    delete:
      description: Delete an existing cost metric configuration.
      operationId: delete_cost_metric_configuration_costMetricConfigurations__costMetricConfigurationId___delete
      parameters:
      - description: The ID of the cost metric configuration to delete.
        in: path
        name: costMetricConfigurationId
        required: true
        schema:
          description: The ID of the cost metric configuration to delete.
          title: costMetricConfigurationId
          type: string
      responses:
        '204':
          description: Cost metric configuration successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete cost metric configuration by cost metric configuration ID
      tags:
      - AI Robustness Tests
    get:
      description: Retrieve an existing cost metric configuration.
      operationId: get_cost_metric_configuration_costMetricConfigurations__costMetricConfigurationId___get
      parameters:
      - description: The ID of the cost metric configuration to retrieve.
        in: path
        name: costMetricConfigurationId
        required: true
        schema:
          description: The ID of the cost metric configuration to retrieve.
          title: costMetricConfigurationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostMetricConfigurationResponse'
          description: Cost metric configuration successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve cost metric configuration by cost metric configuration ID
      tags:
      - AI Robustness Tests
    patch:
      description: Edit an existing cost metric configuration.
      operationId: update_cost_metric_configuration_costMetricConfigurations__costMetricConfigurationId___patch
      parameters:
      - description: The ID of the cost metric configuration to edit.
        in: path
        name: costMetricConfigurationId
        required: true
        schema:
          description: The ID of the cost metric configuration to edit.
          title: costMetricConfigurationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditCostMetricConfigurationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostMetricConfigurationResponse'
          description: Cost metric configuration successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit cost metric configuration by cost metric configuration ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/customModelEmbeddingValidations/:
    get:
      description: List custom model embedding validations.
      operationId: list_custom_model_embeddings_customModelEmbeddingValidations__get
      parameters:
      - description: Only retrieve the custom model embedding validations associated
          with these use case IDs.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the custom model embedding validations associated
            with these use case IDs.
          title: useCaseId
      - description: Only retrieve the custom model embedding validations associated
          with this playground ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model embedding validations associated
            with this playground ID.
          title: playgroundId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the custom model embedding validations matching
          the search query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model embedding validations matching
            the search query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "deploymentName", "userName", "creationDate". Prefix the attribute name
          with a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListCustomModelValidationSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "deploymentName", "userName", "creationDate". Prefix the attribute name
            with a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: If `true`, only retrieve the completed custom model embedding
          validations. The default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the completed custom model embedding
            validations. The default is `false`.
          title: completedOnly
          type: boolean
      - description: Only retrieve the custom model embedding validations associated
          with this deployment ID.
        in: query
        name: deploymentId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model embedding validations associated
            with this deployment ID.
          title: deploymentId
      - description: Only retrieve the custom model embedding validations associated
          with this model ID.
        in: query
        name: modelId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model embedding validations associated
            with this model ID.
          title: modelId
      - description: Only retrieve the custom model embedding validations where the
          custom model uses this column name for prompt input.
        in: query
        name: promptColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model embedding validations where
            the custom model uses this column name for prompt input.
          title: promptColumnName
      - description: Only retrieve the custom model embedding validations where the
          custom model uses this column name for prediction output.
        in: query
        name: targetColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model embedding validations where
            the custom model uses this column name for prediction output.
          title: targetColumnName
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomModelEmbeddingValidationResponse'
          description: Custom model embedding validations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List custom model embedding validations
      tags:
      - Vector Databases
    post:
      description: Validate an embedding model hosted in a custom model deployment
        for use in the playground.
      operationId: create_custom_model_embedding_validation_customModelEmbeddingValidations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomModelEmbeddingValidationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelEmbeddingValidationResponse'
          description: Custom model embedding validation job successfully accepted.
            Follow the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Validate custom model embedding
      tags:
      - Vector Databases
  /api/v2/genai/customModelEmbeddingValidations/{validationId}/:
    delete:
      description: Delete an existing custom model embedding validation.
      operationId: delete_custom_model_embedding_validation_customModelEmbeddingValidations__validationId___delete
      parameters:
      - description: The ID of the custom model embedding validation to delete.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model embedding validation to delete.
          title: validationId
          type: string
      responses:
        '204':
          description: Custom model embedding validation successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete custom model embedding validation by validation ID
      tags:
      - Vector Databases
    get:
      description: Retrieve the status of validating a custom model embedding.
      operationId: get_custom_model_embedding_validation_customModelEmbeddingValidations__validationId___get
      parameters:
      - description: The ID of the custom model embedding validation to retrieve.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model embedding validation to retrieve.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelEmbeddingValidationResponse'
          description: Custom model embedding validation status successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve custom model embedding validation status by validation ID
      tags:
      - Vector Databases
    patch:
      description: Edit an existing custom model embedding validation.
      operationId: update_custom_model_validation_customModelEmbeddingValidations__validationId___patch
      parameters:
      - description: The ID of the custom model embedding validation to edit.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model embedding validation to edit.
          title: validationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditCustomModelValidationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelEmbeddingValidationResponse'
          description: Custom model embedding validation successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit custom model embedding validation by validation ID
      tags:
      - Vector Databases
  /api/v2/genai/customModelEmbeddingValidations/{validationId}/revalidate/:
    post:
      description: Revalidate an existing custom model embedding validation.
      operationId: revalidate_custom_model_embedding_validation_customModelEmbeddingValidations__validationId__revalidate__post
      parameters:
      - description: The ID of the custom model embedding validation to revalidate.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model embedding validation to revalidate.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelEmbeddingValidationResponse'
          description: Custom model embedding successfully revalidated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Revalidate custom model embedding by validation ID
      tags:
      - Vector Databases
  /api/v2/genai/customModelLLMValidations/:
    get:
      description: List custom model LLM validations.
      operationId: list_custom_model_llm_validations_customModelLLMValidations__get
      parameters:
      - description: Only retrieve the custom model LLM validations associated with
          these use case IDs.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the custom model LLM validations associated with
            these use case IDs.
          title: useCaseId
      - description: Only retrieve the custom model LLM validations associated with
          this playground ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model LLM validations associated with
            this playground ID.
          title: playgroundId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the custom model LLM validations matching the search
          query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model LLM validations matching the
            search query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "deploymentName", "userName", "creationDate". Prefix the attribute name
          with a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListCustomModelValidationSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "deploymentName", "userName", "creationDate". Prefix the attribute name
            with a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: If `true`, only retrieve the completed custom model LLM validations.
          The default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the completed custom model LLM validations.
            The default is `false`.
          title: completedOnly
          type: boolean
      - description: Only retrieve the custom model LLM validations associated with
          this deployment ID.
        in: query
        name: deploymentId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model LLM validations associated with
            this deployment ID.
          title: deploymentId
      - description: Only retrieve the custom model LLM validations associated with
          this model ID.
        in: query
        name: modelId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model LLM validations associated with
            this model ID.
          title: modelId
      - description: Only retrieve the custom model LLM validations where the custom
          model uses this column name for prompt input.
        in: query
        name: promptColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model LLM validations where the custom
            model uses this column name for prompt input.
          title: promptColumnName
      - description: Only retrieve the custom model LLM validations where the custom
          model uses this column name for prediction output.
        in: query
        name: targetColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model LLM validations where the custom
            model uses this column name for prediction output.
          title: targetColumnName
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomModelLLMValidationsResponse'
          description: Custom model LLM validations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List custom model LLM validations
      tags:
      - LLM Generation
    post:
      description: Validate an LLM hosted in a custom model deployment for use in
        the playground.
      operationId: create_custom_model_llm_validation_customModelLLMValidations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomModelLLMValidationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelLLMValidationResponse'
          description: Custom model LLM validation job successfully accepted. Follow
            the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Validate custom model LLM
      tags:
      - LLM Generation
  /api/v2/genai/customModelLLMValidations/{validationId}/:
    delete:
      description: Delete an existing custom model LLM validation.
      operationId: delete_custom_model_llm_validation_customModelLLMValidations__validationId___delete
      parameters:
      - description: The ID of the custom model LLM validation to delete.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model LLM validation to delete.
          title: validationId
          type: string
      responses:
        '204':
          description: Custom model LLM validation successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete custom model LLM validation by validation ID
      tags:
      - LLM Generation
    get:
      description: Retrieve the status of validating a custom model LLM.
      operationId: get_custom_model_llm_validation_customModelLLMValidations__validationId___get
      parameters:
      - description: The ID of the custom model LLM validation to retrieve.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model LLM validation to retrieve.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelLLMValidationResponse'
          description: Custom model LLM validation status successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve custom model LLM validation status by validation ID
      tags:
      - LLM Generation
    patch:
      description: Edit an existing custom model LLM validation.
      operationId: update_custom_model_llm_validation_customModelLLMValidations__validationId___patch
      parameters:
      - description: The ID of the custom model LLM validation to edit.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model LLM validation to edit.
          title: validationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditCustomModelValidationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelLLMValidationResponse'
          description: Custom model LLM validation successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit custom model LLM validation by validation ID
      tags:
      - LLM Generation
  /api/v2/genai/customModelLLMValidations/{validationId}/revalidate/:
    post:
      description: Revalidate an existing custom model LLM validation.
      operationId: revalidate_custom_model_llm_validation_customModelLLMValidations__validationId__revalidate__post
      parameters:
      - description: The ID of the custom model LLM validation to revalidate.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model LLM validation to revalidate.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelLLMValidationResponse'
          description: Custom model LLM successfully revalidated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Revalidate custom model LLM by validation ID
      tags:
      - LLM Generation
  /api/v2/genai/customModelVectorDatabaseValidations/:
    get:
      description: List custom model vector database validations.
      operationId: list_custom_model_vector_database_validations_customModelVectorDatabaseValidations__get
      parameters:
      - description: Only retrieve the custom model vector database validations associated
          with these use case IDs.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            associated with these use case IDs.
          title: useCaseId
      - description: Only retrieve the custom model vector database validations associated
          with this playground ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            associated with this playground ID.
          title: playgroundId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the custom model vector database validations matching
          the search query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            matching the search query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "deploymentName", "userName", "creationDate". Prefix the attribute name
          with a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListCustomModelValidationSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "deploymentName", "userName", "creationDate". Prefix the attribute name
            with a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: If `true`, only retrieve the completed custom model vector database
          validations. The default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the completed custom model vector
            database validations. The default is `false`.
          title: completedOnly
          type: boolean
      - description: Only retrieve the custom model vector database validations associated
          with this deployment ID.
        in: query
        name: deploymentId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            associated with this deployment ID.
          title: deploymentId
      - description: Only retrieve the custom model vector database validations associated
          with this model ID.
        in: query
        name: modelId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            associated with this model ID.
          title: modelId
      - description: Only retrieve the custom model vector database validations where
          the custom model uses this column name for prompt input.
        in: query
        name: promptColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            where the custom model uses this column name for prompt input.
          title: promptColumnName
      - description: Only retrieve the custom model vector database validations where
          the custom model uses this column name for prediction output.
        in: query
        name: targetColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the custom model vector database validations
            where the custom model uses this column name for prediction output.
          title: targetColumnName
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomModelVectorDatabaseValidationsResponse'
          description: Custom model vector database validations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List custom model vector database validations
      tags:
      - Vector Databases
    post:
      description: Validate a vector database hosted in a custom model deployment
        for use in the playground.
      operationId: create_custom_model_vector_database_validation_customModelVectorDatabaseValidations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomModelVectorDatabaseValidationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVectorDatabaseValidationResponse'
          description: Custom model vector database validation job successfully accepted.
            Follow the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Validate custom model vector database
      tags:
      - Vector Databases
  /api/v2/genai/customModelVectorDatabaseValidations/{validationId}/:
    delete:
      description: Delete an existing custom model vector database validation.
      operationId: delete_custom_model_vector_database_validation_customModelVectorDatabaseValidations__validationId___delete
      parameters:
      - description: The ID of the custom model vector database validation to delete.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model vector database validation to delete.
          title: validationId
          type: string
      responses:
        '204':
          description: Successfully deleted custom model vector database validation
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete custom model vector database validation by validation ID
      tags:
      - Vector Databases
    get:
      description: Retrieve the status of validating a custom model vector database.
      operationId: get_custom_model_vector_database_validation_customModelVectorDatabaseValidations__validationId___get
      parameters:
      - description: The ID of the custom model vector database validation to retrieve.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model vector database validation to retrieve.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVectorDatabaseValidationResponse'
          description: Custom model vector database validation status successfully
            retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve custom model vector database validation status by validation
        ID
      tags:
      - Vector Databases
    patch:
      description: Edit an existing custom model vector database validation.
      operationId: update_custom_model_vector_database_validation_customModelVectorDatabaseValidations__validationId___patch
      parameters:
      - description: The ID of the custom model vector database validation to edit.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model vector database validation to edit.
          title: validationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditCustomModelValidationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVectorDatabaseValidationResponse'
          description: Custom model vector database validation successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit custom model vector database validation by validation ID
      tags:
      - Vector Databases
  /api/v2/genai/customModelVectorDatabaseValidations/{validationId}/revalidate/:
    post:
      description: Revalidate an existing custom model vector database.
      operationId: revalidate_custom_model_vector_database_validation_customModelVectorDatabaseValidations__validationId__revalidate__post
      parameters:
      - description: The ID of the custom model vector database validation to revalidate.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the custom model vector database validation to revalidate.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomModelVectorDatabaseValidationResponse'
          description: Custom model vector database successfully revalidated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Revalidate custom model vector database by validation ID
      tags:
      - Vector Databases
  /api/v2/genai/customModelVersions/:
    post:
      description: Export the specified LLM blueprint as a custom model version in
        Model Registry.
      operationId: create_custom_model_version_customModelVersions__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomModelVersionRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomModelVersionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create custom model version
      tags:
      - LLM Generation
  /api/v2/genai/evaluationDatasetConfigurations/:
    get:
      description: List evaluation dataset configurations.
      operationId: list_evaluation_dataset_configuration_evaluationDatasetConfigurations__get
      parameters:
      - description: Only retrieve the evaluation dataset configurations associated
          with this use case ID.
        in: query
        name: useCaseId
        required: true
        schema:
          description: Only retrieve the evaluation dataset configurations associated
            with this use case ID.
          title: useCaseId
          type: string
      - description: Only retrieve the evaluation dataset configuration associated
          with this playground ID.
        in: query
        name: playgroundId
        required: true
        schema:
          description: Only retrieve the evaluation dataset configuration associated
            with this playground ID.
          title: playgroundId
          type: string
      - description: Only retrieve the evaluation dataset configuration with this
          ID.
        in: query
        name: evaluationDatasetConfigurationId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the evaluation dataset configuration with this
            ID.
          title: evaluationDatasetConfigurationId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the evaluation dataset configurations matching
          the search query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the evaluation dataset configurations matching
            the search query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "creationUserId", "creationDate", "datasetId", "userName", "datasetName",
          "promptColumnName", "responseColumnName". Prefix the attribute name with
          a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListEvaluationDatasetConfigurationsQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "creationUserId", "creationDate", "datasetId", "userName", "datasetName",
            "promptColumnName", "responseColumnName". Prefix the attribute name with
            a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: If `true`, only retrieve the evaluation dataset configurations
          with correctness enabled. The default is `false`.
        in: query
        name: correctnessEnabledOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the evaluation dataset configurations
            with correctness enabled. The default is `false`.
          title: correctnessEnabledOnly
          type: boolean
      - description: If `true`, only retrieve the evaluation dataset configurations
          where the evaluation dataset is in the completed status. The default is
          `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the evaluation dataset configurations
            where the evaluation dataset is in the completed status. The default is
            `false`.
          title: completedOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEvaluationDatasetConfigurationResponse'
          description: Evaluation dataset configurations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List evaluation dataset configurations
      tags:
      - AI Robustness Tests
    post:
      description: Create a new evaluation dataset configuration.
      operationId: create_evaluation_dataset_configuration_evaluationDatasetConfigurations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEvaluationDatasetConfigurationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationDatasetConfigurationResponse'
          description: Evaluation dataset configuration successfully created
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create evaluation dataset configuration
      tags:
      - AI Robustness Tests
  /api/v2/genai/evaluationDatasetConfigurations/{evaluationDatasetConfigurationId}/:
    delete:
      description: Delete an existing evaluation dataset configuration.
      operationId: delete_evaluation_dataset_configuration_evaluationDatasetConfigurations__evaluationDatasetConfigurationId___delete
      parameters:
      - description: The ID of the evaluation dataset configuration to delete.
        in: path
        name: evaluationDatasetConfigurationId
        required: true
        schema:
          description: The ID of the evaluation dataset configuration to delete.
          title: evaluationDatasetConfigurationId
          type: string
      responses:
        '204':
          description: Evaluation dataset configuration successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete evaluation dataset configuration by evaluation dataset configuration
        ID
      tags:
      - AI Robustness Tests
    get:
      description: Retrieve an existing evaluation dataset configuration.
      operationId: get_evaluation_dataset_configuration_evaluationDatasetConfigurations__evaluationDatasetConfigurationId___get
      parameters:
      - description: The ID of the evaluation dataset configuration to retrieve.
        in: path
        name: evaluationDatasetConfigurationId
        required: true
        schema:
          description: The ID of the evaluation dataset configuration to retrieve.
          title: evaluationDatasetConfigurationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationDatasetConfigurationResponse'
          description: Evaluation dataset configuration successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve evaluation dataset configuration by evaluation dataset configuration
        ID
      tags:
      - AI Robustness Tests
    patch:
      description: Edit an existing evaluation dataset configuration.
      operationId: update_evaluation_dataset_configuration_evaluationDatasetConfigurations__evaluationDatasetConfigurationId___patch
      parameters:
      - description: The ID of the evaluation dataset configuration to edit.
        in: path
        name: evaluationDatasetConfigurationId
        required: true
        schema:
          description: The ID of the evaluation dataset configuration to edit.
          title: evaluationDatasetConfigurationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditEvaluationDatasetConfigurationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationDatasetConfigurationResponse'
          description: Evaluation dataset configuration successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit evaluation dataset configuration by evaluation dataset configuration
        ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/evaluationDatasetMetricAggregations/:
    delete:
      description: Delete the evaluation dataset metric aggregation associated with
        the specified LLM blueprint IDs and/or chat IDs.
      operationId: delete_evaluation_dataset_metric_aggregation_evaluationDatasetMetricAggregations__delete
      parameters:
      - description: The IDs of the LLM blueprints to delete the associated evaluation
          dataset metric aggregation for. If both `llmBlueprintIds` and `chatIds`
          are specified, will delete the aggregation record only if it matches both
          criteria.
        in: query
        name: llmBlueprintIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: The IDs of the LLM blueprints to delete the associated evaluation
            dataset metric aggregation for. If both `llmBlueprintIds` and `chatIds`
            are specified, will delete the aggregation record only if it matches both
            criteria.
          title: llmBlueprintIds
      - description: The IDs of the chats to delete the associated evaluation dataset
          metric aggregation for. If both `llmBlueprintIds` and `chatIds` are specified,
          will delete the aggregation record only if it matches both criteria.
        in: query
        name: chatIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: The IDs of the chats to delete the associated evaluation dataset
            metric aggregation for. If both `llmBlueprintIds` and `chatIds` are specified,
            will delete the aggregation record only if it matches both criteria.
          title: chatIds
      responses:
        '204':
          description: Evaluation dataset metric aggregation successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete evaluation dataset metric aggregation
      tags:
      - AI Robustness Tests
    get:
      description: List evaluation dataset metric aggregations.
      operationId: list_evaluation_dataset_metric_aggregation_evaluationDatasetMetricAggregations__get
      parameters:
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these LLM blueprint IDs.
        in: query
        name: llmBlueprintIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these LLM blueprint IDs.
          title: llmBlueprintIds
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these chat IDs.
        in: query
        name: chatIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these chat IDs.
          title: chatIds
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these evaluation dataset configuration IDs.
        in: query
        name: evaluationDatasetConfigurationIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these evaluation dataset configuration IDs.
          title: evaluationDatasetConfigurationIds
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these metric names.
        in: query
        name: metricNames
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these metric names.
          title: metricNames
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these aggregation types.
        in: query
        name: aggregationTypes
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/AggregationType'
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these aggregation types.
          title: aggregationTypes
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with the current configuration of the llmblueprints.
        in: query
        name: currentConfigurationOnly
        required: false
        schema:
          default: false
          description: Only retrieve the evaluation dataset metric aggregations associated
            with the current configuration of the llmblueprints.
          title: currentConfigurationOnly
          type: boolean
      - description: Apply this sort order to the results. Valid options are "name",
          "creationUserId", "creationDate", "datasetId", "userName", "datasetName",
          "promptColumnName", "responseColumnName". Prefix the attribute name with
          a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListEvaluationDatasetMetricAggregationSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "creationUserId", "creationDate", "datasetId", "userName", "datasetName",
            "promptColumnName", "responseColumnName". Prefix the attribute name with
            a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: If `true`, only retrieve the evaluation dataset metric aggregations
          that are in a non-errored status. The default is `false`.
        in: query
        name: nonErroredOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the evaluation dataset metric aggregations
            that are in a non-errored status. The default is `false`.
          title: nonErroredOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEvaluationDatasetMetricAggregationResponse'
          description: Evaluation dataset metric aggregations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List evaluation dataset metric aggregations
      tags:
      - AI Robustness Tests
    post:
      description: Create a new evaluation dataset metric aggregation.
      operationId: create_evaluation_dataset_metric_aggregation_evaluationDatasetMetricAggregations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEvaluationDatasetMetricAggregationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEvaluationDatasetMetricAggregationResponse'
          description: Evaluation dataset metric aggregation job successfully accepted.
            Follow the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create evaluation dataset metric aggregation
      tags:
      - AI Robustness Tests
  /api/v2/genai/evaluationDatasetMetricAggregations/aggregateByLLMBlueprint/:
    get:
      description: List evaluation dataset metric aggregations aggregated by llm blueprint.
      operationId: list_evaluation_dataset_metric_aggregation_aggregated_by_llm_blueprint_evaluationDatasetMetricAggregations_aggregateByLLMBlueprint__get
      parameters:
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these LLM blueprint IDs.
        in: query
        name: llmBlueprintIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these LLM blueprint IDs.
          title: llmBlueprintIds
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these chat IDs.
        in: query
        name: chatIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these chat IDs.
          title: chatIds
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these evaluation dataset configuration IDs.
        in: query
        name: evaluationDatasetConfigurationIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these evaluation dataset configuration IDs.
          title: evaluationDatasetConfigurationIds
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these metric names.
        in: query
        name: metricNames
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these metric names.
          title: metricNames
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with these aggregation types.
        in: query
        name: aggregationTypes
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/AggregationType'
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the evaluation dataset metric aggregations associated
            with these aggregation types.
          title: aggregationTypes
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with the current configuration of the llmblueprints.
        in: query
        name: currentConfigurationOnly
        required: false
        schema:
          default: false
          description: Only retrieve the evaluation dataset metric aggregations associated
            with the current configuration of the llmblueprints.
          title: currentConfigurationOnly
          type: boolean
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: If `true`, only retrieve the evaluation dataset metric aggregations
          that are in a non-errored status. The default is `false`.
        in: query
        name: nonErroredOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the evaluation dataset metric aggregations
            that are in a non-errored status. The default is `false`.
          title: nonErroredOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEvaluationDatasetMetricAggregationAggregatedByLLMBlueprintResponse'
          description: Evaluation dataset metric aggregations aggregated by llm blueprint
            successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List evaluation dataset metric aggregations aggregated by llm blueprint.
      tags:
      - AI Robustness Tests
  /api/v2/genai/evaluationDatasetMetricAggregations/uniqueFieldValues/{uniqueField}/:
    get:
      description: List evaluation dataset metric aggregations unique computed metrics.
      operationId: list_evaluation_dataset_metric_aggregation_unique_field_values_evaluationDatasetMetricAggregations_uniqueFieldValues__uniqueField___get
      parameters:
      - description: Retrieve the list of this unique field.
        in: path
        name: uniqueField
        required: true
        schema:
          $ref: '#/components/schemas/EvaluationDatasetMetricAggregationFieldQueryParam'
          description: Retrieve the list of this unique field.
      - description: Only retrieve the list of the unique field associated with these
          LLM blueprint IDs.
        in: query
        name: llmBlueprintIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the list of the unique field associated with
            these LLM blueprint IDs.
          title: llmBlueprintIds
      - description: Only retrieve the list of the unique field associated with these
          metric names.
        in: query
        name: metricNames
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the list of the unique field associated with
            these metric names.
          title: metricNames
      - description: Only retrieve the list of the unique field associated with these
          chat IDs.
        in: query
        name: chatIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the list of the unique field associated with
            these chat IDs.
          title: chatIds
      - description: Only retrieve the list of the unique field associated with these
          evaluation dataset configuration IDs.
        in: query
        name: evaluationDatasetConfigurationIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the list of the unique field associated with
            these evaluation dataset configuration IDs.
          title: evaluationDatasetConfigurationIds
      - description: Only retrieve the list of the unique field associated with these
          aggregation types.
        in: query
        name: aggregationTypes
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/AggregationType'
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the list of the unique field associated with
            these aggregation types.
          title: aggregationTypes
      - description: Only retrieve the evaluation dataset metric aggregations associated
          with the current configuration of the llmblueprints.
        in: query
        name: currentConfigurationOnly
        required: false
        schema:
          default: false
          description: Only retrieve the evaluation dataset metric aggregations associated
            with the current configuration of the llmblueprints.
          title: currentConfigurationOnly
          type: boolean
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: If `true`, only retrieve the list of the unique field for aggregation
          records that are in a non-errored status. The default is `false`.
        in: query
        name: nonErroredOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the list of the unique field for aggregation
            records that are in a non-errored status. The default is `false`.
          title: nonErroredOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEvaluationDatasetMetricAggregationUniqueFieldValuesResponse'
          description: Evaluation dataset metric aggregations unique computed metrics
            successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List evaluation dataset metric aggregations unique computed metrics
        by uniquefield
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmBlueprints/:
    get:
      description: List LLM blueprints.
      operationId: list_llm_blueprints_llmBlueprints__get
      parameters:
      - description: Playground ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Playground ID.
          title: playgroundId
      - description: Retrieve only the LLM blueprints that use the specified LLM IDs.
        in: query
        name: llmIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Retrieve only the LLM blueprints that use the specified LLM
            IDs.
          title: llmIds
      - description: Retrieve only the LLM blueprints linked to the specified vector
          database IDs.
        in: query
        name: vectorDatabaseIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Retrieve only the LLM blueprints linked to the specified vector
            database IDs.
          title: vectorDatabaseIds
      - description: Retrieve only the LLM blueprints that have the specified draft/saved
          status.
        in: query
        name: isSaved
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Retrieve only the LLM blueprints that have the specified draft/saved
            status.
          title: isSaved
      - description: Retrieve only the LLM blueprints that have the specified starred
          status.
        in: query
        name: isStarred
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Retrieve only the LLM blueprints that have the specified starred
            status.
          title: isStarred
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Apply this sort order to the results. Valid options are "name",
          "description", "creationDate", "lastUpdateDate", "llmId", "vectorDatabaseId".
          Prefix the attribute name with a dash to sort in descending order, e.g.,
          sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListLLMBlueprintSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "description", "creationDate", "lastUpdateDate", "llmId", "vectorDatabaseId".
            Prefix the attribute name with a dash to sort in descending order, e.g.,
            sort=-creationDate.
          title: sort
      - description: Retrieve only the LLM blueprints created by these users.
        in: query
        name: creationUserIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Retrieve only the LLM blueprints created by these users.
          title: creationUserIds
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMBlueprintsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List LLM blueprints
      tags:
      - LLM Generation
    post:
      description: Create a new LLM blueprint.
      operationId: create_llm_blueprint_llmBlueprints__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLLMBlueprintRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMBlueprintResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create LLM blueprint
      tags:
      - LLM Generation
  /api/v2/genai/llmBlueprints/fromChatPrompt/:
    post:
      description: Create a new LLM blueprint using the LLM and vector database settings
        currently used by the specified existing chat prompt.
      operationId: create_from_chat_prompt_llmBlueprints_fromChatPrompt__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFromChatPromptRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMBlueprintResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create a LLM blueprints from a chat prompt
      tags:
      - LLM Generation
  /api/v2/genai/llmBlueprints/fromLLMBlueprint/:
    post:
      description: Create a new LLM blueprint using the LLM and vector database settings
        currently used by the specified existing LLM blueprint.
      operationId: create_from_llm_blueprint_llmBlueprints_fromLLMBlueprint__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFromLLMBlueprintRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMBlueprintResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Duplicate LLM blueprint
      tags:
      - LLM Generation
  /api/v2/genai/llmBlueprints/{llmBlueprintId}/:
    delete:
      description: Delete an existing LLM blueprint.
      operationId: delete_llm_blueprint_llmBlueprints__llmBlueprintId___delete
      parameters:
      - description: The ID of the LLM blueprint to delete.
        in: path
        name: llmBlueprintId
        required: true
        schema:
          description: The ID of the LLM blueprint to delete.
          title: llmBlueprintId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete LLM blueprint by LLM blueprint ID
      tags:
      - LLM Generation
    get:
      description: Retrieve an existing LLM blueprint.
      operationId: get_llm_blueprint_llmBlueprints__llmBlueprintId___get
      parameters:
      - description: The ID of the LLM blueprint to retrieve.
        in: path
        name: llmBlueprintId
        required: true
        schema:
          description: The ID of the LLM blueprint to retrieve.
          title: llmBlueprintId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMBlueprintResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve LLM blueprint by LLM blueprint ID
      tags:
      - LLM Generation
    patch:
      description: Edit an existing LLM blueprint.
      operationId: update_llm_blueprint_llmBlueprints__llmBlueprintId___patch
      parameters:
      - description: The ID of the LLM blueprint to edit.
        in: path
        name: llmBlueprintId
        required: true
        schema:
          description: The ID of the LLM blueprint to edit.
          title: llmBlueprintId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLLMBlueprintRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMBlueprintResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit LLM blueprint by LLM blueprint ID
      tags:
      - LLM Generation
  /api/v2/genai/llmTestConfigurations/:
    get:
      description: List LLM test configuration.
      operationId: list_llm_test_configurations_llmTestConfigurations__get
      parameters:
      - description: Use Case ID.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Use Case ID.
          title: useCaseId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Whether to return out-of-the-box (ootb) or custom LLM test configurations
          in the response.
        in: query
        name: testConfigType
        required: false
        schema:
          $ref: '#/components/schemas/LLMTestConfigurationType'
          default: custom
          description: Whether to return out-of-the-box (ootb) or custom LLM test
            configurations in the response.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMTestConfigurationsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List LLM test configuration
      tags:
      - AI Robustness Tests
    post:
      description: Create a new LLM test configuration.
      operationId: create_llm_test_configuration_llmTestConfigurations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLLMTestConfigurationRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestConfigurationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create LLM test configuration
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestConfigurations/nonOotbDatasets/:
    get:
      description: List the supported non out-of-the-box datasets that can be used
        with an LLM test configuration.
      operationId: list_llm_test_configuration_non_ootb_datasets_llmTestConfigurations_nonOotbDatasets__get
      parameters:
      - description: Use Case ID.
        in: query
        name: useCaseId
        required: true
        schema:
          description: Use Case ID.
          title: useCaseId
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the datasets with names matching the search query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the datasets with names matching the search query.
          title: search
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMTestConfigurationNonOOTBDatasetsResponse'
          description: Non out-of-the-box datasets successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List non out-of-the-box datasets
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestConfigurations/ootbDatasets/:
    get:
      description: List the supported out-of-the-box datasets that can be used with
        an LLM test configuration.
      operationId: list_llm_test_configuration_ootb_datasets_llmTestConfigurations_ootbDatasets__get
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the datasets with names matching the search query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the datasets with names matching the search query.
          title: search
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMTestConfigurationOOTBDatasetsResponse'
          description: Out-of-the-box datasets successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List out-of-the-box datasets
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestConfigurations/supportedInsights/:
    get:
      description: List the supported LLM test insight configurations for the specified
        use case.
      operationId: list_llm_test_configuration_supported_insights_llmTestConfigurations_supportedInsights__get
      parameters:
      - description: If specified, only retrieve the insights supported by this use
          case ID.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, only retrieve the insights supported by this
            use case ID.
          title: useCaseId
      - description: If specified, only retrieve the insights supported by the use
          case for which the playgroundId belongs.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, only retrieve the insights supported by the use
            case for which the playgroundId belongs.
          title: playgroundId
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestConfigurationSupportedInsightsResponse'
          description: LLM test supported insight configurations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List supported insights
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestConfigurations/{llmTestConfigurationId}/:
    delete:
      description: Delete an existing LLM test configuration.
      operationId: delete_llm_test_configuration_llmTestConfigurations__llmTestConfigurationId___delete
      parameters:
      - description: The ID of the LLM Test Configuration to delete.
        in: path
        name: llmTestConfigurationId
        required: true
        schema:
          description: The ID of the LLM Test Configuration to delete.
          title: llmTestConfigurationId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete LLM test configuration by LLM test configuration ID
      tags:
      - AI Robustness Tests
    get:
      description: Retrieve an existing LLM test configuration.
      operationId: get_llm_test_configuration_llmTestConfigurations__llmTestConfigurationId___get
      parameters:
      - description: The ID of the LLM Test Configuration to retrieve.
        in: path
        name: llmTestConfigurationId
        required: true
        schema:
          description: The ID of the LLM Test Configuration to retrieve.
          title: llmTestConfigurationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestConfigurationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve LLM test configuration by LLM test configuration ID
      tags:
      - AI Robustness Tests
    patch:
      description: Edit an existing LLM test configuration.
      operationId: edit_llm_test_configuration_llmTestConfigurations__llmTestConfigurationId___patch
      parameters:
      - description: The ID of the LLM Test Configuration to update.
        in: path
        name: llmTestConfigurationId
        required: true
        schema:
          description: The ID of the LLM Test Configuration to update.
          title: llmTestConfigurationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditLLMTestConfigurationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestConfigurationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit LLM test configuration by LLM test configuration ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestResults/:
    get:
      description: List LLM test results.
      operationId: list_llm_test_results_llmTestResults__get
      parameters:
      - description: LLM Test Configuration ID.
        in: query
        name: llmTestConfigurationId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: LLM Test Configuration ID.
          title: llmTestConfigurationId
      - description: LLM Blueprint ID.
        in: query
        name: llmBlueprintId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: LLM Blueprint ID.
          title: llmBlueprintId
      - description: LLM Test Suite ID.
        in: query
        name: llmTestSuiteId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: LLM Test Suite ID.
          title: llmTestSuiteId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMTestResultResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List LLM test results
      tags:
      - AI Robustness Tests
    post:
      description: Create a new LLM test result.
      operationId: create_llm_test_result_llmTestResults__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLLMTestResultRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestResultResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create LLM test result
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestResults/{llmTestResultId}/:
    delete:
      description: Delete an existing LLM test result.
      operationId: delete_llm_test_result_llmTestResults__llmTestResultId___delete
      parameters:
      - description: The ID of the LLM Test Result to delete.
        in: path
        name: llmTestResultId
        required: true
        schema:
          description: The ID of the LLM Test Result to delete.
          title: llmTestResultId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete LLM test result by LLM test result ID
      tags:
      - AI Robustness Tests
    get:
      description: Retrieve an existing LLM test result.
      operationId: get_llm_test_result_llmTestResults__llmTestResultId___get
      parameters:
      - description: The ID of the LLM Test Result to retrieve.
        in: path
        name: llmTestResultId
        required: true
        schema:
          description: The ID of the LLM Test Result to retrieve.
          title: llmTestResultId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestResultResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve LLM test result by LLM test result ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestSuites/:
    get:
      description: List LLM test suites.
      operationId: list_llm_test_suites_llmTestSuites__get
      parameters:
      - description: Only retrieve the LLM test suites associated with this use case
          ID.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the LLM test suites associated with this use
            case ID.
          title: useCaseId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Apply this sort order to the results. Valid options are "name"
          and "creationDate". Prefix the attribute name with a dash to sort in descending
          order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListLLMTestSuiteSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name"
            and "creationDate". Prefix the attribute name with a dash to sort in descending
            order, e.g., sort=-creationDate.
          title: sort
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMTestSuitesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List LLM test suites
      tags:
      - AI Robustness Tests
    post:
      description: Create a new LLM test suite.
      operationId: create_llm_test_suite_llmTestSuites__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLLMTestSuiteRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestSuiteResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create LLM test suite
      tags:
      - AI Robustness Tests
  /api/v2/genai/llmTestSuites/{llmTestSuiteId}/:
    delete:
      description: Delete an existing LLM test suite.
      operationId: delete_llm_test_suite_llmTestSuites__llmTestSuiteId___delete
      parameters:
      - description: The ID of the LLM test suite to delete.
        in: path
        name: llmTestSuiteId
        required: true
        schema:
          description: The ID of the LLM test suite to delete.
          title: llmTestSuiteId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete LLM test suite by LLM test suite ID
      tags:
      - AI Robustness Tests
    get:
      description: Retrieve an existing LLM test suite.
      operationId: get_llm_test_suite_llmTestSuites__llmTestSuiteId___get
      parameters:
      - description: The ID of the LLM test suite to retrieve.
        in: path
        name: llmTestSuiteId
        required: true
        schema:
          description: The ID of the LLM test suite to retrieve.
          title: llmTestSuiteId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestSuiteResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve LLM test suite by LLM test suite ID
      tags:
      - AI Robustness Tests
    patch:
      description: Edit an existing LLM test suite.
      operationId: edit_llm_test_suite_llmTestSuites__llmTestSuiteId___patch
      parameters:
      - description: The ID of the LLM test suite to edit.
        in: path
        name: llmTestSuiteId
        required: true
        schema:
          description: The ID of the LLM test suite to edit.
          title: llmTestSuiteId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditLLMTestSuiteRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LLMTestSuiteResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit LLM test suite by LLM test suite ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/llms/:
    get:
      description: List the large language models (LLMs) available in the DataRobot
        platform for the current user.
      operationId: list_llms_llms__get
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 200
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 200
          title: limit
          type: integer
      - description: If specified, include custom model LLMs available for this use
          case.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, include custom model LLMs available for this
            use case.
          title: useCaseId
      - description: Whether to include only active models.
        in: query
        name: activeOnly
        required: false
        schema:
          default: false
          description: Whether to include only active models.
          title: activeOnly
          type: boolean
      - description: Whether to include only the models available for moderations.
        in: query
        name: moderationSupportedOnly
        required: false
        schema:
          default: false
          description: Whether to include only the models available for moderations.
          title: moderationSupportedOnly
          type: boolean
      - description: Whether to include only the models available for chat completions.
        in: query
        name: chatCompletionsSupportedOnly
        required: false
        schema:
          default: false
          description: Whether to include only the models available for chat completions.
          title: chatCompletionsSupportedOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLLMsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List LLMs
      tags:
      - LLM Generation
  /api/v2/genai/llms/{llmId}/:
    get:
      description: Get the large language model (LLM) by ID.
      operationId: get_llm_llms__llmId___get
      parameters:
      - description: The ID of the LLM to retrieve.
        in: path
        name: llmId
        required: true
        schema:
          description: The ID of the LLM to retrieve.
          title: llmId
          type: string
      - description: If specified, include custom model LLMs available for this use
          case.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, include custom model LLMs available for this
            use case.
          title: useCaseId
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LanguageModelDefinitionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Get LLM by LLM ID
      tags:
      - LLM Generation
  /api/v2/genai/ootbMetricConfigurations/{ootbMetricConfigurationId}/:
    delete:
      description: Delete single OOTB metric configuration.
      operationId: delete_ootb_metric_configuration_ootbMetricConfigurations__ootbMetricConfigurationId___delete
      parameters:
      - description: The ID of the metric configuration.
        in: path
        name: ootbMetricConfigurationId
        required: true
        schema:
          description: The ID of the metric configuration.
          title: ootbMetricConfigurationId
          type: string
      responses:
        '204':
          description: OOTB metric configuration successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete OOTB metric configuration by ootb metric configuration ID
      tags:
      - AI Robustness Tests
    get:
      description: Get OOTB metric configuration from the configuration.
      operationId: get_ootb_metric_configuration_ootbMetricConfigurations__ootbMetricConfigurationId___get
      parameters:
      - description: The ID of the metric configuration.
        in: path
        name: ootbMetricConfigurationId
        required: true
        schema:
          description: The ID of the metric configuration.
          title: ootbMetricConfigurationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OOTBMetricConfigurationResponse'
          description: OOTB metric configuration
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Get OOTB metric configuration by ootb metric configuration ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/playgrounds/:
    get:
      description: List playgrounds.
      operationId: list_playgrounds_playgrounds__get
      parameters:
      - description: Only retrieve the playgrounds linked to the specified use cases.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the playgrounds linked to the specified use cases.
          title: useCaseId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the playgrounds with names matching the search
          query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the playgrounds with names matching the search
            query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId",
          "savedLLMBlueprintsCount". Prefix the attribute name with a dash to sort
          in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListPlaygroundSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "description", "creationDate", "creationUserId", "lastUpdateDate", "lastUpdateUserId",
            "savedLLMBlueprintsCount". Prefix the attribute name with a dash to sort
            in descending order, e.g., sort=-creationDate.
          title: sort
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPlaygroundsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List playgrounds
      tags:
      - LLM Generation
    post:
      description: Create a new playground.
      operationId: create_playground_playgrounds__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlaygroundRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaygroundResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create playground
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/:
    delete:
      description: Delete an existing playground.
      operationId: delete_playground_playgrounds__playgroundId___delete
      parameters:
      - description: The ID of the playground to delete.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to delete.
          title: playgroundId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete playground by playground ID
      tags:
      - LLM Generation
    get:
      description: Retrieve an existing playground.
      operationId: get_playground_playgrounds__playgroundId___get
      parameters:
      - description: The ID of the playground to retrieve.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve.
          title: playgroundId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaygroundResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve playground by playground ID
      tags:
      - LLM Generation
    patch:
      description: Edit an existing playground.
      operationId: update_playground_playgrounds__playgroundId___patch
      parameters:
      - description: The ID of the playground to edit.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to edit.
          title: playgroundId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditPlaygroundRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaygroundResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit playground by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/:
    delete:
      description: Delete the NeMo configuration for the playground.
      operationId: delete_playground_nemo_configuration_playgrounds__playgroundId__nemoConfiguration__delete
      parameters:
      - description: The ID of the playground to retrieve NeMo configuration for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve NeMo configuration for.
          title: playgroundId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete the NeMo configuration by playground ID
      tags:
      - LLM Generation
    get:
      description: Retrieve the NeMo configuration for the playground.
      operationId: get_playground_nemo_configuration_playgrounds__playgroundId__nemoConfiguration__get
      parameters:
      - description: The ID of the playground to retrieve NeMo configuration for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve NeMo configuration for.
          title: playgroundId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NemoConfigurationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrive the NeMo configuration by playground ID
      tags:
      - LLM Generation
    post:
      description: Update/insert the NeMo configuration for the playground.
      operationId: upsert_playground_nemo_configuration_playgrounds__playgroundId__nemoConfiguration__post
      parameters:
      - description: The ID of the playground to retrieve NeMo configuration for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve NeMo configuration for.
          title: playgroundId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NemoConfigurationUpsertRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NemoConfigurationResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Update/insert the NeMo configuration by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/nemoConfiguration/{metricId}/:
    delete:
      description: Delete a NeMo metric for the playground.
      operationId: delete_nemo_metric_playgrounds__playgroundId__nemoConfiguration__metricId___delete
      parameters:
      - description: The ID of the playground to retrieve NeMo configuration for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve NeMo configuration for.
          title: playgroundId
          type: string
      - description: The ID of the metric to delete.
        in: path
        name: metricId
        required: true
        schema:
          description: The ID of the metric to delete.
          title: metricId
          type: string
      responses:
        '204':
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete a NeMo metric by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/ootbMetricConfigurations/:
    get:
      description: List OOTB metric configurations for the selected playground.
      operationId: list_ootb_metric_configurations_playgrounds__playgroundId__ootbMetricConfigurations__get
      parameters:
      - description: The ID of the playground.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground.
          title: playgroundId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OOTBMetricConfigurationsResponse'
          description: OOTB metric configurations list
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List OOTB metric configurations by playground ID
      tags:
      - LLM Generation
    post:
      description: Create a new OOTB metric configuration.
      operationId: create_ootb_metric_configuration_playgrounds__playgroundId__ootbMetricConfigurations__post
      parameters:
      - description: The ID of the playground associated with the OOTB metric configuration.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground associated with the OOTB metric configuration.
          title: playgroundId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOOTBMetricConfigurationsRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OOTBMetricConfigurationsResponse'
          description: OOTB metric configuration created successfully
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create OOTB metric configuration by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/supportedInsights/:
    get:
      description: List the supported insights.
      operationId: get_supported_insights_playgrounds__playgroundId__supportedInsights__get
      parameters:
      - description: The ID of the playground to retrieve supported insights from.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve supported insights from.
          title: playgroundId
          type: string
      - description: If `true`, only include the insights containing aggregation types.
          The default is `false`.
        in: query
        name: withAggregationTypesOnly
        required: false
        schema:
          default: false
          description: If `true`, only include the insights containing aggregation
            types. The default is `false`.
          title: withAggregationTypesOnly
          type: boolean
      - description: If `true`, only include the insights that can be transferred
          to production. The default is `false`.
        in: query
        name: productionOnly
        required: false
        schema:
          default: false
          description: If `true`, only include the insights that can be transferred
            to production. The default is `false`.
          title: productionOnly
          type: boolean
      - description: If `true`, only include the insights that are completed. The
          default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only include the insights that are completed. The
            default is `false`.
          title: completedOnly
          type: boolean
      - description: The IDs of the LLM blueprints to check for VDB related metrics
          support.
        in: query
        name: llmBlueprintIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: The IDs of the LLM blueprints to check for VDB related metrics
            support.
          title: llmBlueprintIds
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedInsightsResponse'
          description: Supported insights configuration successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List supported insights by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/trace/:
    get:
      description: Retrieve the playground prompt traces for an existing playground.
      operationId: playground_trace_playgrounds__playgroundId__trace__get
      parameters:
      - description: The ID of the playground to retrieve prompt traces for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve prompt traces for.
          title: playgroundId
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTracesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve playground prompt traces by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/trace/metadata/:
    get:
      description: Retrieve the prompt traces metadata for an existing playground.
      operationId: playground_trace_metadata_playgrounds__playgroundId__trace_metadata__get
      parameters:
      - description: The ID of the playground to retrieve prompt traces for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to retrieve prompt traces for.
          title: playgroundId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceMetadataResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve playground prompt traces metadata by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{playgroundId}/traceDatasets/:
    post:
      description: Export prompt traces for an existing playground as a Data Registry
        dataset.
      operationId: create_chat_export_job_playgrounds__playgroundId__traceDatasets__post
      parameters:
      - description: The ID of the playground to export the prompt traces for.
        in: path
        name: playgroundId
        required: true
        schema:
          description: The ID of the playground to export the prompt traces for.
          title: playgroundId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTraceDatasetRequest'
              default:
                excludeTracesWithWarnings: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceDatasetResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create playground prompt trace dataset by playground ID
      tags:
      - LLM Generation
  /api/v2/genai/playgrounds/{targetPlaygroundId}/supportedInsights/{sourcePlaygroundId}/:
    put:
      description: Copy supported insights between playgrounds.
      operationId: copy_supported_insights_playgrounds__targetPlaygroundId__supportedInsights__sourcePlaygroundId___put
      parameters:
      - description: The ID of the source playground to copy supported insights from.
        in: path
        name: sourcePlaygroundId
        required: true
        schema:
          description: The ID of the source playground to copy supported insights
            from.
          title: sourcePlaygroundId
          type: string
      - description: The ID of the target playground to copy supported insights to.
        in: path
        name: targetPlaygroundId
        required: true
        schema:
          description: The ID of the target playground to copy supported insights
            to.
          title: targetPlaygroundId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopySupportedInsightsRequest'
        required: true
      responses:
        '204':
          description: Supported insights configuration successfully copied.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Copy supported insights by target playground ID
      tags:
      - LLM Generation
  /api/v2/genai/promptTemplates/:
    get:
      description: List prompt templates for the user with optional filtering and
        sorting.
      operationId: list_prompt_templates_promptTemplates__get
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Apply this sort order to the results. Valid options are "name",
          "description", "creationDate", "lastUpdateDate". Prefix the attribute name
          with a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/PromptTemplatesSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "description", "creationDate", "lastUpdateDate". Prefix the attribute
            name with a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: Only retrieve prompt templates with names matching the search
          query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve prompt templates with names matching the search
            query.
          title: search
      - description: Retrieve only the prompt templates created by these users.
        in: query
        name: creationUserIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Retrieve only the prompt templates created by these users.
          title: creationUserIds
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPromptTemplatesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List prompt templates
      tags:
      - Prompting
    post:
      description: Create a new prompt template.
      operationId: create_prompt_template_promptTemplates__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePromptTemplateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptTemplateResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create prompt template
      tags:
      - Prompting
  /api/v2/genai/promptTemplates/versions/:
    get:
      description: List prompt templates versions for the user with optional filtering.
      operationId: list_prompt_templates_versions_promptTemplates_versions__get
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Retrieve only versions with matching prompt templates ids.
        in: query
        name: promptTemplatesIds
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Retrieve only versions with matching prompt templates ids.
          title: promptTemplatesIds
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPromptTemplateVersionsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List prompt templates versions
      tags:
      - Prompting
  /api/v2/genai/promptTemplates/{promptTemplateId}/:
    get:
      description: Get prompt template by ID.
      operationId: get_prompt_template_promptTemplates__promptTemplateId___get
      parameters:
      - description: The ID of the prompt template to retrieve.
        in: path
        name: promptTemplateId
        required: true
        schema:
          description: The ID of the prompt template to retrieve.
          title: promptTemplateId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptTemplateResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Get prompt template by prompt template ID
      tags:
      - Prompting
  /api/v2/genai/promptTemplates/{promptTemplateId}/versions/:
    get:
      description: List versions for a prompt template with pagination.
      operationId: list_prompt_template_versions_promptTemplates__promptTemplateId__versions__get
      parameters:
      - description: The ID of the prompt template to retrieve.
        in: path
        name: promptTemplateId
        required: true
        schema:
          description: The ID of the prompt template to retrieve.
          title: promptTemplateId
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPromptTemplateVersionsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List prompt template versions by prompt template ID
      tags:
      - Prompting
    post:
      description: Create a new prompt template version.
      operationId: create_prompt_template_version_promptTemplates__promptTemplateId__versions__post
      parameters:
      - description: The ID of the prompt template to create a version for.
        in: path
        name: promptTemplateId
        required: true
        schema:
          description: The ID of the prompt template to create a version for.
          title: promptTemplateId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePromptTemplateVersionRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptTemplateVersionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create prompt template version by prompt template ID
      tags:
      - Prompting
  /api/v2/genai/promptTemplates/{promptTemplateId}/versions/{promptTemplateVersionId}/:
    get:
      description: Get prompt template version by ID.
      operationId: get_prompt_template_version_promptTemplates__promptTemplateId__versions__promptTemplateVersionId___get
      parameters:
      - description: The ID of the prompt template version to retrieve.
        in: path
        name: promptTemplateVersionId
        required: true
        schema:
          description: The ID of the prompt template version to retrieve.
          title: promptTemplateVersionId
          type: string
      - description: The ID of the prompt template to retrieve.
        in: path
        name: promptTemplateId
        required: true
        schema:
          description: The ID of the prompt template to retrieve.
          title: promptTemplateId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptTemplateVersionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Get prompt template version by prompt template ID
      tags:
      - Prompting
  /api/v2/genai/sidecarModelMetricValidations/:
    get:
      description: List sidecar model metric validations.
      operationId: list_sidecar_model_validations_sidecarModelMetricValidations__get
      parameters:
      - description: Only retrieve the sidecar model metric validations associated
          with these use case IDs.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the sidecar model metric validations associated
            with these use case IDs.
          title: useCaseId
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the sidecar model metric validations matching the
          search query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the sidecar model metric validations matching
            the search query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "deploymentName", "userName", "creationDate". Prefix the attribute name
          with a dash to sort in descending order, e.g., sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListCustomModelValidationSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "deploymentName", "userName", "creationDate". Prefix the attribute name
            with a dash to sort in descending order, e.g., sort=-creationDate.
          title: sort
      - description: If `true`, only retrieve the completed sidecar model metric validations.
          The default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the completed sidecar model metric
            validations. The default is `false`.
          title: completedOnly
          type: boolean
      - description: Only retrieve the sidecar model metric validations associated
          with this deployment ID.
        in: query
        name: deploymentId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the sidecar model metric validations associated
            with this deployment ID.
          title: deploymentId
      - description: Only retrieve the sidecar model metric validations associated
          with this model ID.
        in: query
        name: modelId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the sidecar model metric validations associated
            with this model ID.
          title: modelId
      - description: Only retrieve the sidecar model metric validations where the
          custom model uses this column name for prompt input.
        in: query
        name: promptColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the sidecar model metric validations where the
            custom model uses this column name for prompt input.
          title: promptColumnName
      - description: Only retrieve the sidecar model metric validations where the
          custom model uses this column name for prediction output.
        in: query
        name: targetColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the sidecar model metric validations where the
            custom model uses this column name for prediction output.
          title: targetColumnName
      - description: Only retrieve the sidecar model metric validations where the
          custom model uses this column name prefix for citation inputs.
        in: query
        name: citationsPrefixColumnName
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the sidecar model metric validations where the
            custom model uses this column name prefix for citation inputs.
          title: citationsPrefixColumnName
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSidecarModelMetricValidationnResponse'
          description: Sidecar model metric validations successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List sidecar model metric validations
      tags:
      - AI Robustness Tests
    post:
      description: Validate a metric hosted in a custom model deployment (also known
        as a sidecar model metric) for use in the playground.
      operationId: create_sidecar_model_metric_validation_sidecarModelMetricValidations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSidecarModelMetricValidationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SidecarModelMetricValidationResponse'
          description: Sidecar model metric validation job successfully accepted.
            Follow the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Validate sidecar model metric
      tags:
      - AI Robustness Tests
  /api/v2/genai/sidecarModelMetricValidations/{validationId}/:
    delete:
      description: Delete an existing sidecar model metric validation.
      operationId: delete_sidecar_model_metric_validation_sidecarModelMetricValidations__validationId___delete
      parameters:
      - description: The ID of the sidecar model metric validation to delete.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the sidecar model metric validation to delete.
          title: validationId
          type: string
      responses:
        '204':
          description: Sidecar model metric validation successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete sidecar model metric validation by validation ID
      tags:
      - AI Robustness Tests
    get:
      description: Retrieve the status of validating a sidecar model metric.
      operationId: get_sidecar_model_metric_validation_sidecarModelMetricValidations__validationId___get
      parameters:
      - description: The ID of the sidecar model metric validation to retrieve.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the sidecar model metric validation to retrieve.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SidecarModelMetricValidationResponse'
          description: Sidecar model metric validation status successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve sidecar model metric validation status by validation ID
      tags:
      - AI Robustness Tests
    patch:
      description: Edit an existing sidecar model metric validation.
      operationId: update_sidecar_model_metric_validation_sidecarModelMetricValidations__validationId___patch
      parameters:
      - description: The ID of the sidecar model metric validation to edit.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the sidecar model metric validation to edit.
          title: validationId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditSidecarModelMetricValidationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SidecarModelMetricValidationResponse'
          description: Sidecar model metric validation successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit sidecar model metric validation by validation ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/sidecarModelMetricValidations/{validationId}/revalidate/:
    post:
      description: Revalidate an existing sidecar model metric validation.
      operationId: revalidate_sidecar_model_validation_sidecarModelMetricValidations__validationId__revalidate__post
      parameters:
      - description: The ID of the sidecar model metric validation to revalidate.
        in: path
        name: validationId
        required: true
        schema:
          description: The ID of the sidecar model metric validation to revalidate.
          title: validationId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SidecarModelMetricValidationResponse'
          description: Sidecar model metric successfully revalidated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Revalidate sidecar model metric by validation ID
      tags:
      - AI Robustness Tests
  /api/v2/genai/status/{statusId}/:
    get:
      description: Retrieve the execution status of a GenAI worker job.
      operationId: get_status_status__statusId___get
      parameters:
      - description: The ID of the job to retrieve the status for.
        in: path
        name: statusId
        required: true
        schema:
          description: The ID of the job to retrieve the status for.
          format: uuid
          title: statusId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/StatusResponse'
                - type: string
                title: Response Get Status Status  Statusid   Get
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve job status by status ID
      tags:
      - LLM Generation
  /api/v2/genai/syftrSearch/:
    get:
      description: Return all search studies for the specified use case .
      operationId: list_search_study_syftrSearch__get
      parameters:
      - description: Use case ID to retrieve search studies from.
        in: query
        name: useCaseId
        required: true
        schema:
          description: Use case ID to retrieve search studies from.
          title: useCaseId
          type: string
      - description: Skip the specified number of search studies.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of search studies.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of search studies.
        in: query
        name: limit
        required: false
        schema:
          default: 200
          description: Retrieve only the specified number of search studies.
          exclusiveMinimum: 0
          maximum: 200
          title: limit
          type: integer
      - description: Playground ID associated with a search study.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Playground ID associated with a search study.
          title: playgroundId
      - description: Only retrieve the search studies with names matching the search
          query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the search studies with names matching the search
            query.
          title: search
      - description: Apply this sort order to the results.Valid options are 'name'.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListSearchStudySortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results.Valid options are 'name'.
          title: sort
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSearchStudyResponse'
          description: Search studies has been successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List search studies by use case ID.
      tags:
      - Agents
    post:
      description: Run agentic search.
      operationId: run_agentic_search_syftrSearch__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunAgenticSearchRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunSearchApiResponse'
          description: Agentic search job successfully accepted. Follow the `Location`
            header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Run agentic search.
      tags:
      - Agents
  /api/v2/genai/syftrSearch/{searchStudyId}/:
    delete:
      description: Delete existing search study object from the database.
      operationId: delete_search_study_syftrSearch__searchStudyId___delete
      parameters:
      - description: The ID of the search study to be retrieved.
        in: path
        name: searchStudyId
        required: true
        schema:
          description: The ID of the search study to be retrieved.
          title: searchStudyId
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSearchApiResponse'
          description: Search study has been successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete existing search study by ID by search study ID
      tags:
      - Agents
    get:
      description: Return existing search study object from the database.
      operationId: get_search_study_syftrSearch__searchStudyId___get
      parameters:
      - description: The ID of the search study to be retrieved.
        in: path
        name: searchStudyId
        required: true
        schema:
          description: The ID of the search study to be retrieved.
          title: searchStudyId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchStudyResponse'
          description: Search study has been successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Get existing search study by ID by search study ID
      tags:
      - Agents
    patch:
      description: Edit an existing search study object.
      operationId: edit_search_study_syftrSearch__searchStudyId___patch
      parameters:
      - description: The ID of the search study to be edited.
        in: path
        name: searchStudyId
        required: true
        schema:
          description: The ID of the search study to be edited.
          title: searchStudyId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditSearchStudyRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit search study by search study ID
      tags:
      - Agents
  /api/v2/genai/syntheticEvaluationDatasetGenerations/:
    post:
      description: Generate a synthetic evaluation dataset.
      operationId: generate_synthetic_dataset_syntheticEvaluationDatasetGenerations__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyntheticEvaluationDatasetGenerationRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyntheticEvaluationDatasetGenerationResponse'
          description: Synthetic evaluation data generation job successfully accepted.
            Follow the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Generate synthetic evaluation dataset
      tags:
      - AI Robustness Tests
  /api/v2/genai/userLimits/llmApiCalls/:
    get:
      deprecated: true
      description: 'DEPRECATED: Retrieve count of LLM Api calls made by user. This
        endpoint is deprecated and will be removed in future releases. Please use
        the appropriate LLM Gateway stats endpoint instead: /api/v2/genai/llmgw/stats/llmApiCalls/
        .'
      operationId: get_user_limit_counter_for_llm_api_calls_userLimits_llmApiCalls__get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveUserLimitCounterResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: '[DEPRECATED] Retrieve LLM API call count'
      tags:
      - LLM Generation
  /api/v2/genai/userLimits/vectorDatabases/:
    get:
      description: Retrieve the number of vector databases the user has created which
        count towards the usage limit.
      operationId: get_user_limit_counter_for_vector_databases_userLimits_vectorDatabases__get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveUserLimitCounterResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve vector database creation count
      tags:
      - LLM Generation
  /api/v2/genai/vectorDatabases/:
    get:
      description: List vector databases.
      operationId: list_vector_databases_vectorDatabases__get
      parameters:
      - description: Only retrieve the vector databases linked to these use case IDs.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1000
            type: array
          - type: 'null'
          description: Only retrieve the vector databases linked to these use case
            IDs.
          title: useCaseId
      - description: Only retrieve the vector databases linked to this playground
          ID.
        in: query
        name: playgroundId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the vector databases linked to this playground
            ID.
          title: playgroundId
      - description: Only retrieve the vector databases linked to this family ID.
        in: query
        name: familyId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the vector databases linked to this family ID.
          title: familyId
      - description: If `true`, only retrieve (root) parent vector databases. The
          default is `false`.
        in: query
        name: parentsOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve (root) parent vector databases. The
            default is `false`.
          title: parentsOnly
          type: boolean
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: limit
          type: integer
      - description: Only retrieve the vector databases with names matching the search
          query.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 5000
            type: string
          - type: 'null'
          description: Only retrieve the vector databases with names matching the
            search query.
          title: search
      - description: Apply this sort order to the results. Valid options are "name",
          "creationDate", "creationUserId", "embeddingModel", "datasetId", "chunkingMethod",
          "chunksCount", "size", "userName", "datasetName", "playgroundsCount", "source".
          Prefix the attribute name with a dash to sort in descending order, e.g.,
          sort=-creationDate.
        in: query
        name: sort
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ListVectorDatabaseSortQueryParam'
          - type: 'null'
          description: Apply this sort order to the results. Valid options are "name",
            "creationDate", "creationUserId", "embeddingModel", "datasetId", "chunkingMethod",
            "chunksCount", "size", "userName", "datasetName", "playgroundsCount",
            "source". Prefix the attribute name with a dash to sort in descending
            order, e.g., sort=-creationDate.
          title: sort
      - description: If `true`, only retrieve the vector databases that have finished
          building. The default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the vector databases that have finished
            building. The default is `false`.
          title: completedOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVectorDatabasesResponse'
          description: Vector databases successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List vector databases
      tags:
      - Vector Databases
    post:
      description: Create a new vector database.
      operationId: create_vector_database_vectorDatabases__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVectorDatabaseRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseResponse'
          description: Vector database creation job successfully accepted. Follow
            the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create vector database
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/fromCustomModelDeployment/:
    post:
      description: Create a new vector database from a custom model deployment.
      operationId: create_custom_model_vector_database_vectorDatabases_fromCustomModelDeployment__post
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/CreateCustomModelVectorDatabaseFromValidationIdPayload'
              - $ref: '#/components/schemas/CreateCustomModelVectorDatabaseFromDeploymentRequest'
              title: Payload
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseResponse'
          description: Custom model hosted vector database successfully added. Full
            representation is available in the response body.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create a vector databases from a custom model deployment
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/supportedEmbeddings/:
    get:
      description: List the supported embedding models for building vector databases.
      operationId: get_supported_embeddings_vectorDatabases_supportedEmbeddings__get
      parameters:
      - description: Only retrieve the embedding models compatible with this dataset
          ID.
        in: query
        name: datasetId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only retrieve the embedding models compatible with this dataset
            ID.
          title: datasetId
      - description: If specified, include the custom model embeddings available for
          this use case ID.
        in: query
        name: useCaseId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: If specified, include the custom model embeddings available
            for this use case ID.
          title: useCaseId
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedEmbeddingsResponse'
          description: Supported embeddings successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List supported embedding models
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/supportedRetrievalSettings/:
    get:
      description: List all vector database retrieval settings that are supported
        by LLM blueprints.
      operationId: get_supported_retrieval_settings_vectorDatabases_supportedRetrievalSettings__get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedRetrievalSettingsResponse'
          description: Supported vector database retrieval settings successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List supported vector database retrieval settings
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/supportedTextChunkings/:
    get:
      description: List the supported text chunking methods for building vector databases.
      operationId: get_supported_text_chunking_configs_vectorDatabases_supportedTextChunkings__get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedTextChunkingResponse'
          description: Supported text chunking methods successfully retrieved.
      summary: List supported text chunking methods
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/:
    delete:
      description: Delete an existing vector database.
      operationId: delete_vector_database_vectorDatabases__vectorDatabaseId___delete
      parameters:
      - description: The ID of the vector database to delete.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to delete.
          title: vectorDatabaseId
          type: string
      responses:
        '204':
          description: Vector database successfully deleted.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Delete vector database by vector database ID
      tags:
      - Vector Databases
    get:
      description: Retrieve an existing vector database.
      operationId: get_vector_database_vectorDatabases__vectorDatabaseId___get
      parameters:
      - description: The ID of the vector database to retrieve.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to retrieve.
          title: vectorDatabaseId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseResponse'
          description: Vector database successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve vector database by vector database ID
      tags:
      - Vector Databases
    patch:
      description: Edit an existing vector database.
      operationId: update_vector_database_vectorDatabases__vectorDatabaseId___patch
      parameters:
      - description: The ID of the vector database to edit.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to edit.
          title: vectorDatabaseId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditVectorDatabaseRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseResponse'
          description: Vector database successfully updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Edit vector database by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/customModelVersions/:
    post:
      description: Export the specified Vector Database as a custom model version
        in Model Registry.
      operationId: create_vector_database_custom_model_version_vectorDatabases__vectorDatabaseId__customModelVersions__post
      parameters:
      - description: The ID of the vector database to create a custom model version
          for.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to create a custom model version
            for.
          title: vectorDatabaseId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVectorDatabaseCustomModelVersionRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomModelVersionResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create custom model version by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/datasetExportJobs/:
    post:
      description: Export an existing vector database as dataset to Data Registry.
      operationId: export_vector_database_dataset_vectorDatabases__vectorDatabaseId__datasetExportJobs__post
      parameters:
      - description: The ID of the vector database to retrieve.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to retrieve.
          title: vectorDatabaseId
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseExportResponse'
          description: Vector database export job successfully accepted.Follow the
            `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Export vector database dataset by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/deployments/:
    post:
      description: Export the specified vector database as a custom model version,
        register it, and deploy it on a new deployment.
      operationId: create_vector_database_deployment_vectorDatabases__vectorDatabaseId__deployments__post
      parameters:
      - description: The ID of the vector database to create a custom model version
          for.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to create a custom model version
            for.
          title: vectorDatabaseId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVectorDatabaseDeploymentRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVectorDatabaseDeploymentResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Create new custom model version by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/externalVectorDatabaseDocuments/:
    patch:
      description: Add documents to a connected vector database.
      operationId: update_connected_vector_database_vectorDatabases__vectorDatabaseId__externalVectorDatabaseDocuments__patch
      parameters:
      - description: The ID of the vector database to edit.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to edit.
          title: vectorDatabaseId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectedVectorDatabaseRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseResponse'
          description: Connected vector database update job successfully accepted.
            Follow the `Location` header to poll for job execution status.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Add documents by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/latestVersion/:
    get:
      description: Retrieve the latest vector database within the family associated
        with this vector database.
      operationId: get_vector_database_latest_version_vectorDatabases__vectorDatabaseId__latestVersion__get
      parameters:
      - description: The ID of the vector database to retrieve the latest version.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to retrieve the latest version.
          title: vectorDatabaseId
          type: string
      - description: If `true`, only retrieve the vector databases that have finished
          building. The default is `false`.
        in: query
        name: completedOnly
        required: false
        schema:
          default: false
          description: If `true`, only retrieve the vector databases that have finished
            building. The default is `false`.
          title: completedOnly
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorDatabaseResponse'
          description: Latest vector database version successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve vector database latest version by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/supportedSyntheticDatasetGenerationLanguages/:
    get:
      description: List the languages for synthetic dataset generation that are supported
        by this vector database.
      operationId: get_supported_languages_vectorDatabases__vectorDatabaseId__supportedSyntheticDatasetGenerationLanguages__get
      parameters:
      - description: The ID of the vector database to retrieve supported languages.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to retrieve supported languages.
          title: vectorDatabaseId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedLanguagesResponse'
          description: Supported languages successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: List supported languages by vector database ID
      tags:
      - Vector Databases
  /api/v2/genai/vectorDatabases/{vectorDatabaseId}/textAndEmbeddings/:
    get:
      description: Retrieve the text chunk and embeddings asset for an existing vector
        database.
      operationId: download_text_and_embeddings_asset_vectorDatabases__vectorDatabaseId__textAndEmbeddings__get
      parameters:
      - description: The ID of the vector database to retrieve the assets for.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          description: The ID of the vector database to retrieve the assets for.
          title: vectorDatabaseId
          type: string
      - description: Retrieve the additional file for this addition number.
        in: query
        name: part
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Retrieve the additional file for this addition number.
          title: part
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Text and embeddings asset successfully retrieved.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationErrorResponse'
          description: Validation Error
      summary: Retrieve text chunks and embeddings by vector database ID
      tags:
      - Vector Databases
  /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: 0
          maximum: 100
          type: integer
      - description: User groups must contain the substring.
        in: query
        name: namePart
        required: false
        schema:
          default: ''
          type: string
      - description: List user groups by the specified IDs.
        in: query
        name: groupIds
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
      - 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 a 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 a user group by group ID
      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 a user group by group ID
      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 a user group by group ID
      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 by group ID
      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: 0
          maximum: 100
          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 by group ID
      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 by group ID
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/guardConfigurations/:
    get:
      description: The list of resource tags.
      operationId: guardConfigurations_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: 0
          type: integer
      - description: Filter guard configurations by the given entity ID.
        in: query
        name: entityId
        required: true
        schema:
          type: string
      - description: The entity type of the given entity ID.
        in: query
        name: entityType
        required: true
        schema:
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardConfigurationListResponse'
          description: ''
        '400':
          description: Request invalid, refer to messages for detail.
        '404':
          description: User permissions problem.
      summary: The list of resource tags.
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
    post:
      description: Create a guard configuration.
      operationId: guardConfigurations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuardConfigurationCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardConfigurationRetrieveResponse'
          description: ''
        '404':
          description: Either the resource does not exist or the user does not have
            permission to create the configuration.
        '409':
          description: The proposed configuration name is already in use for the same
            entity.
      summary: Create a guard configuration.
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /api/v2/guardConfigurations/predictionEnvironmentsInUse/:
    get:
      description: Show the prediction environments in use for moderation.
      operationId: guardConfigurationsPredictionEnvironmentsInUse_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: 0
          type: integer
      - description: Show prediction environment information for this custom model
          version.
        in: query
        name: customModelVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardConfigurationPredictionEnvironmentsInUseListResponse'
          description: ''
        '404':
          description: Either the resource does not exist or the user does not have
            permission to view the configuration.
      summary: Show the prediction environments in use
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /api/v2/guardConfigurations/toNewCustomModelVersion/:
    post:
      description: Apply moderation configuration to a new custom model version.
      operationId: guardConfigurationsToNewCustomModelVersion_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuardConfigurationToCustomModelVersion'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardConfigurationToCustomModelResponse'
          description: ''
        '404':
          description: Either the resource does not exist or the user does not have
            permission to create the configuration.
        '409':
          description: The destination custom model version is frozen. Create a new
            version to save configuration.
      summary: Apply moderation configuration
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /api/v2/guardConfigurations/{configId}/:
    delete:
      description: Delete a guard config.
      operationId: guardConfigurations_delete
      parameters:
      - description: The ID of the configuration.
        in: path
        name: configId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '404':
          description: Either the config does not exist or the user does not have
            permission to delete it.
      summary: Delete a guard config by config ID
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
    get:
      description: Retrieve info about a guard configuration.
      operationId: guardConfigurations_retrieve
      parameters:
      - description: The ID of the configuration.
        in: path
        name: configId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardConfigurationRetrieveResponse'
          description: ''
        '404':
          description: Either the config does not exist or the user does not have
            permission to view it.
      summary: Retrieve info about a guard configuration by config ID
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
    patch:
      description: Update a guard config.
      operationId: guardConfigurations_patch
      parameters:
      - description: The ID of the configuration.
        in: path
        name: configId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuardConfigurationUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardConfigurationRetrieveResponse'
          description: ''
        '404':
          description: Either the resource does not exist or the user does not have
            permission to create the configuration.
        '409':
          description: The proposed configuration name is already in use for the same
            entity.
      summary: Update a guard config by config ID
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /api/v2/guardTemplates/:
    get:
      description: List guard templates.
      operationId: guardTemplates_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: 0
          type: integer
      - description: Include agentic and non-agentic templates in results (by default,
          agentic templates are not included).
        in: query
        name: includeAgentic
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Limit results to agentic templates. If true, this overrides either
          includeAgentic setting.
        in: query
        name: isAgentic
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter for templates suitable for playground (exclude production-only
          templates).
        in: query
        name: forPlayground
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Filter for templates suitable for production (exclude playground-only
          templates).
        in: query
        name: forProduction
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: Search for templates by name.
        in: query
        name: name
        required: false
        schema:
          default: null
          maxLength: 255
          type:
          - string
          - 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardTemplateListResponse'
          description: ''
        '400':
          description: Request invalid, refer to messages for detail.
        '404':
          description: Missing feature flag.
      summary: List guard templates.
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /api/v2/guardTemplates/{templateId}/:
    get:
      description: Retrieve information about a guard template.
      operationId: guardTemplates_retrieve
      parameters:
      - description: The ID of the template.
        in: path
        name: templateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GuardTemplateRetrieveResponse'
          description: ''
        '404':
          description: Either the template does not exist or the required feature
            flag is missing.
      summary: Retrieve information about a guard template by template ID
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /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
      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: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageAugmentationListsResponse'
          description: Image Augmentation Lists
      summary: List of augmentation lists
      tags:
      - blueprints
      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
      tags:
      - blueprints
      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 by augmentation ID
      tags:
      - blueprints
      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 by augmentation ID
      tags:
      - blueprints
      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 by augmentation ID
      tags:
      - blueprints
      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: 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 by augmentation ID
      tags:
      - blueprints
      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 by augmentation
        ID
      tags:
      - blueprints
      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
        by project ID
      tags:
      - blueprints
      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
      tags:
      - blueprints
      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: 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 by samples ID
      tags:
      - blueprints
      x-versionadded: v2.23
  /api/v2/insights/confusionMatrix/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsConfusionMatrix_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeConfusionMatrixRequest'
      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 Confusion Matrix chart
      tags:
      - insights
      x-versionadded: v2.42
  /api/v2/insights/confusionMatrix/models/{entityId}/:
    get:
      description: The list of paginated Confusion Matrix chart insights.
      operationId: insightsConfusionMatrixModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - (-1, -1)
          - (-1,-1)
          - (0, -1)
          - (0,-1)
          - CV
          - backtest_10
          - backtest_11
          - backtest_12
          - backtest_13
          - backtest_14
          - backtest_15
          - backtest_16
          - backtest_17
          - backtest_18
          - backtest_19
          - backtest_2
          - backtest_20
          - backtest_3
          - backtest_4
          - backtest_5
          - backtest_6
          - backtest_7
          - backtest_8
          - backtest_9
          - crossValidation
          - externalTestSet
          - holdout
          - validation
          - validation_0
          - validation_1
          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: Orders the chart data by the specified attributes.Prefix the
          attribute name with a dash to sort in descending order (e.g., dataOrderBy='-predictedCount).'
        in: query
        name: dataOrderBy
        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: The first row (start index) used when applying slicing to the
          confusion matrix.
        in: query
        name: rowStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The last row (end index) used when applying slicing to the confusion
          matrix.
        in: query
        name: rowEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The first column (start index) used when applying slicing to
          the confusion matrix.
        in: query
        name: colStart
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The last column (end index) used when applying slicing to the
          confusion matrix.
        in: query
        name: colEnd
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The 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/RetrieveConfusionMatrixPaginatedResponse'
          description: Retrieves a model's Confusion Matrix chart.
        '404':
          description: Requested entity ID or data slice ID not found
        '422':
          description: Unsupported project type, or unsupported insight for model
      summary: The list of paginated Confusion Matrix chart insights by entity ID
      tags:
      - insights
      x-versionadded: v2.42
  /api/v2/insights/featureEffects/:
    post:
      description: Request calculation of Feature Effects 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 Feature Effect 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
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/featureEffects/models/{entityId}/:
    get:
      description: The list of paginated Feature Effects insights.
      operationId: insightsFeatureEffectsModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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: The 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: The list of paginated Feature Effects insights by entity ID
      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
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/featureImpact/models/{entityId}/:
    get:
      description: The list of paginated Feature Impact insights.
      operationId: insightsFeatureImpactModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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: The 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: The list of paginated Feature Impact insights by entity ID
      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
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/liftChart/models/{entityId}/:
    get:
      description: The list of paginated lift chart insights.
      operationId: insightsLiftChartModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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: The ID of the external dataset.
        in: query
        name: externalDatasetId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The 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: The list of paginated lift chart insights by entity ID
      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
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/residuals/models/{entityId}/:
    get:
      description: The list of paginated Residuals insights.
      operationId: insightsResidualsModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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: The ID of the external dataset.
        in: query
        name: externalDatasetId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The 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: The list of paginated Residuals insights by entity ID
      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
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/rocCurve/models/{entityId}/:
    get:
      description: The list of paginated ROC curve insights.
      operationId: insightsRocCurveModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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: The ID of the external dataset.
        in: query
        name: externalDatasetId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The 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: The list of paginated ROC curve insights by entity ID
      tags:
      - insights
      x-versionadded: v2.31
  /api/v2/insights/shapDistributions/:
    post:
      description: Request calculation of insight with an optional data slice.
      operationId: insightsShapDistributions_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputeShapDistributionsRequest'
      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 Distributions
      tags:
      - insights
      x-versionadded: v2.35
  /api/v2/insights/shapDistributions/models/{entityId}/:
    get:
      description: The list of paginated SHAP Distributions insights.
      operationId: insightsShapDistributionsModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          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: The ID of the external dataset.
        in: query
        name: externalDatasetId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The maximum number of distribution rows to return.
        in: query
        name: predictionFilterRowCount
        required: false
        schema:
          minimum: 1
          type: integer
      - description: The maximum number of features to return.
        in: query
        name: featureFilterCount
        required: false
        schema:
          minimum: 1
          type: integer
      - description: The names of the features to return.
        in: query
        name: featureFilterName
        required: false
        schema:
          type: string
      - description: When enabled, the default, limits the rows used from the selected
          subset (training sample or slice).
        in: query
        name: quickCompute
        required: false
        schema:
          default: true
          type: boolean
      - description: The series ID used to filter records (for multiseries projects).
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: The forecast distance used to retrieve insight data.
        in: query
        name: forecastDistance
        required: false
        schema:
          minimum: 0
          type: integer
      - description: Order SHAP distributions by the specified field value.
        in: query
        name: featuresOrderBy
        required: false
        schema:
          enum:
          - featureImpact
          - -featureImpact
          - featureName
          - -featureName
          type: string
      - description: The 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/RetrieveShapDistributionsPaginatedResponse'
            text/csv:
              schema:
                type: string
          description: Retrieves a model's SHAP Distributions 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: The list of paginated SHAP Distributions insights by entity ID
      tags:
      - insights
      x-versionadded: v2.35
  /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/ComputeShapInsightsRequest'
      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
      tags:
      - insights
      x-versionadded: v2.35
  /api/v2/insights/shapImpact/models/{entityId}/:
    get:
      description: The list of paginated SHAP Impact insights.
      operationId: insightsShapImpactModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: Subset of data used to compute the insight.
        in: query
        name: source
        required: false
        schema:
          enum:
          - backtest_0
          - backtest_0Training
          - backtest_1
          - backtest_10
          - backtest_10Training
          - backtest_11
          - backtest_11Training
          - backtest_12
          - backtest_12Training
          - backtest_13
          - backtest_13Training
          - backtest_14
          - backtest_14Training
          - backtest_15
          - backtest_15Training
          - backtest_16
          - backtest_16Training
          - backtest_17
          - backtest_17Training
          - backtest_18
          - backtest_18Training
          - backtest_19
          - backtest_19Training
          - backtest_1Training
          - backtest_2
          - backtest_20
          - backtest_20Training
          - backtest_2Training
          - backtest_3
          - backtest_3Training
          - backtest_4
          - backtest_4Training
          - backtest_5
          - backtest_5Training
          - backtest_6
          - backtest_6Training
          - backtest_7
          - backtest_7Training
          - backtest_8
          - backtest_8Training
          - backtest_9
          - backtest_9Training
          - externalTestSet
          - holdout
          - holdoutTraining
          - training
          - validation
          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: When enabled, limits the rows used from the selected source subset
          by default. When disabled, all rows are used.
        in: query
        name: quickCompute
        required: false
        schema:
          type: boolean
      - description: The 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: The list of paginated SHAP Impact insights by entity ID
      tags:
      - insights
      x-versionadded: v2.35
  /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/ComputeShapInsightsRequest'
      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
      tags:
      - insights
      x-versionadded: v2.35
  /api/v2/insights/shapMatrix/models/{entityId}/:
    get:
      description: The list of paginated SHAP Matrix insights.
      operationId: insightsShapMatrixModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          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: The ID of the external dataset.
        in: query
        name: externalDatasetId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: When enabled, limits the rows used from the selected source subset
          by default. When disabled, all rows are used.
        in: query
        name: quickCompute
        required: false
        schema:
          default: true
          type: boolean
      - description: The 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/RetrieveShapMatrixPaginatedResponse'
            text/csv:
              schema:
                type: string
          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: The list of paginated SHAP Matrix insights by entity ID
      tags:
      - insights
      x-versionadded: v2.35
  /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/ComputeShapInsightsRequest'
      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
      tags:
      - insights
      x-versionadded: v2.35
  /api/v2/insights/shapPreview/models/{entityId}/:
    get:
      description: The list of paginated SHAP Preview insights.
      operationId: insightsShapPreviewModels_list
      parameters:
      - description: The number 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: The ID of the data slice.
        in: query
        name: dataSliceId
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The subset of data used to compute the insight.
        in: query
        name: source
        required: false
        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
          - externalTestSet
          - holdout
          - holdout_training
          - training
          - validation
          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: The ID of the external dataset.
        in: query
        name: externalDatasetId
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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: When enabled, limits the rows used from the selected source subset
          by default. When disabled, all rows are used.
        in: query
        name: quickCompute
        required: false
        schema:
          default: true
          type: boolean
      - description: The series ID used to filter records (for multiseries projects).
        in: query
        name: seriesId
        required: false
        schema:
          type: string
      - description: The forecast distance used to retrieve insight data.
        in: query
        name: forecastDistance
        required: false
        schema:
          minimum: 0
          type: integer
      - description: The 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: The list of paginated SHAP Preview insights by entity ID
      tags:
      - insights
      x-versionadded: v2.35
  /api/v2/insights/{insightName}/models/{entityId}/:
    delete:
      description: Delete insights for a specific model.
      operationId: insightsModels_delete
      parameters:
      - description: The name of the insight to be deleted.
        in: path
        name: insightName
        required: true
        schema:
          enum:
          - clusteringBarycentersMetric
          - clusteringDTW
          - confusionMatrix
          - featureEffects
          - featureImpact
          - liftChart
          - residuals
          - rocCurve
          - segmentationPreview
          - shapDistributions
          - shapImpact
          - shapMatrix
          - shapPreview
          - silhouetteDTW
          - timeSeriesClusteringBarycenters
          - umap
          type: string
      - description: The ID of the model.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Model insight records deleted.
        '404':
          description: Data was not found.
      summary: Delete insights by insightname
      tags:
      - insights
      x-versionadded: v2.35
  /api/v2/jdbcDataPreview/:
    post:
      description: Execute SQL against the selected JDBC URL and return a row-limited
        preview. Specify credentials and connection parameters in the JDBC URL and/or
        in the `parameters` field.
      operationId: jdbcDataPreview_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JdbcDataPreview'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStorePreviewResponse'
          description: Returns columns, records, and resultSchema matching the data
            preview shape.
      summary: Preview data
      tags:
      - data_connectivity
      x-versionadded: v2.43
  /api/v2/jdbcExecution/:
    post:
      description: Run a SQL statement that updates data or schema against the given
        JDBC URL. Specify credentials and connection parameters in the JDBC URL and/or
        in the `parameters` field. This does not return a data preview; use the JDBC
        data preview endpoint to fetch row-limited SELECT results.
      operationId: jdbcExecution_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JdbcExecute'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JdbcExecuteResponse'
          description: Returns a short `message` from the connector.
      summary: Execute SQL against a JDBC URL (DDL/DML, procedures).
      tags:
      - data_connectivity
      x-versionadded: v2.45
  /api/v2/mlops/compute/bundles/:
    get:
      description: Retrieve metadata for all resource bundles the user has access
        to.
      feature_flags:
      - &id008
        description: Instead of managing resources (i.e. CPU, memory, and GPU) individually,
          users select an available bundle of resources that best fits their Custom
          Model/Job/App, etc.
        enabled_by_default: false
        maturity: PUBLIC_PREVIEW
        name: MLOPS_RESOURCE_REQUEST_BUNDLES
      maturity: PUBLIC_PREVIEW
      operationId: mlopsComputeBundles_list
      parameters:
      - description: Identifier used to return recommended resource bundles. Must
          be used together with entityType parameter.
        in: query
        name: entityId
        required: false
        schema:
          type: string
        x-versionadded: v2.37
      - description: Type of entity for which to get recommended bundles. Must be
          provided with entityId.
        in: query
        name: entityType
        required: false
        schema:
          enum:
          - customModelTemplate
          type: string
        x-versionadded: v2.37
      - description: If it is specified, only bundles for this use case will be returned.
        in: query
        name: useCases
        required: false
        schema:
          enum:
          - customApplication
          - customJob
          - customModel
          - customTaskFit
          - modelingMachineWorker
          - predictionAPI
          - sapAICore
          - sparkApplication
          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: 0
          maximum: 100
          type: integer
      public_preview: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceRequestBundleListResponse'
          description: List of resource bundle metadata.
        '403':
          description: Resource bundles are not enabled.
      summary: List resource bundles.
      tags:
      - deployment_management
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id008
  /api/v2/mlops/compute/bundles/{resourceRequestBundleId}/:
    get:
      description: Retrieve resource bundle.
      feature_flags:
      - &id009
        description: Instead of managing resources (i.e. CPU, memory, and GPU) individually,
          users select an available bundle of resources that best fits their Custom
          Model/Job/App, etc.
        enabled_by_default: false
        maturity: PUBLIC_PREVIEW
        name: MLOPS_RESOURCE_REQUEST_BUNDLES
      maturity: PUBLIC_PREVIEW
      operationId: mlopsComputeBundles_retrieve
      parameters:
      - description: ID of the bundle.
        in: path
        name: resourceRequestBundleId
        required: true
        schema:
          type: string
      public_preview: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceRequestBundleResponse'
          description: Resource bundle
        '403':
          description: Resource bundles are not enabled or the user does not have
            access to specified bundle.
        '404':
          description: Resource bundle does not exist.
      summary: Retrieve resource bundle by resource request bundle ID
      tags:
      - deployment_management
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id009
  /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:
      - deployment_management
      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:
      - deployment_management
      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 by
        entity ID
      tags:
      - compliance_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 by entity ID
      tags:
      - compliance_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: 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:
      - model_management
      x-versionadded: v2.23
  /api/v2/modelPackages/fromJSON/:
    post:
      description: Create a model package from json.
      operationId: modelPackagesFromJSON_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModelPackageCreateExternal'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageRetrieveResponse'
          description: ''
      summary: Create a model package
      tags:
      - models
      x-versionadded: v2.37
  /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
      tags:
      - model_management
      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 a model packages from a learning model
      tags:
      - model_management
      x-versionadded: v2.26
  /api/v2/modelPackages/{modelPackageId}/:
    get:
      description: Retrieve info about a model package.
      operationId: modelPackages_retrieve
      parameters:
      - description: The 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 by model package ID
      tags:
      - model_management
      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: The ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Archive a model package by model package ID
      tags:
      - model_management
      x-versionadded: v2.21
  /api/v2/modelPackages/{modelPackageId}/capabilities/:
    get:
      description: Retrieve the capabilities for the model package.
      operationId: modelPackagesCapabilities_list
      parameters:
      - description: The 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 by model package ID
      tags:
      - model_management
      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: The sort order to apply to the list of features. Prefix the attribute
          name with a dash to sort in descending order, e.g., "-name".
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - name
          - importance
          - -name
          - -importance
          type: string
      - description: The 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: Model package feature list.
      summary: Retrieve feature list by model package ID
      tags:
      - model_management
      x-versionadded: v2.25
  /api/v2/modelPackages/{modelPackageId}/modelLogs/:
    get:
      description: The list of the model package's model logs.
      operationId: modelPackagesModelLogs_list
      parameters:
      - description: The number of results that will be skipped.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of results to return.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 100
          type: integer
      - description: The ID of the model package.
        in: path
        name: modelPackageId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelPackageModelLogsListResponse'
          description: ''
      summary: The list of the model package's model logs by model package ID
      tags:
      - model_management
      x-versionadded: v2.35
  /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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The 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 the model package's access control list by model package ID
      tags:
      - model_management
      x-versionadded: v2.21
  /api/v2/models/{modelId}/documentTextExtractionSampleDocuments/:
    get:
      description: Retrieve documents with computed document text extraction samples.
      operationId: modelsDocumentTextExtractionSampleDocuments_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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: The 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 by model ID
      tags:
      - features
      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: The 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: 0
          maximum: 100
          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: The 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 by model ID
      tags:
      - features
      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: The 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 by model
        ID
      tags:
      - features
      x-versionadded: v2.32
  /api/v2/moderationSupportedLlms/:
    get:
      description: The list of supported LLMs for moderation.
      operationId: moderationSupportedLlms_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: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedLlmListResponse'
          description: ''
        '400':
          description: Request invalid, refer to messages for detail.
        '404':
          description: Missing feature flag.
      summary: The list of supported LLMs
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /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: The multicategorical feature histogram.
      summary: Retrieve multicategorical feature histogram by multilabelinsightskey
      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 by multilabelinsightskey
      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 by multilabelinsightskey
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/multilabelInsights/{multilabelInsightsKey}/pairwiseManualSelections/{manualSelectionListId}/:
    delete:
      description: Delete the 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: The ID of the deleted label list.
      summary: Delete the label list by multilabelinsightskey
      tags:
      - insights
      x-versionadded: v2.27
    patch:
      description: Update the label list 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: The ID of the updated label list.
      summary: Update the label list name by multilabelinsightskey
      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: The pairwise label statistics.
      summary: Retrieve pairwise statistics by multilabelinsightskey
      tags:
      - insights
      x-versionadded: v2.27
  /api/v2/notebookCodeSnippets/:
    get:
      deprecated: false
      parameters:
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query schema for searching code nuggets.
        in: query
        name: ListSnippetsQuerySchema
        required: false
        schema:
          $ref: '#/components/schemas/ListSnippetsQuerySchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCodeSnippetsResponse'
          description: Response schema for the list of code snippets.
      summary: Retrieve Notebook Code Snippets
      tags:
      - notebooks
  /api/v2/notebookCodeSnippets/tags/:
    get:
      deprecated: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCodeSnippetsTagsResponse'
          description: Response schema for the list of code snippets tags.
      summary: Retrieve Tags
      tags:
      - notebooks
  /api/v2/notebookCodeSnippets/{snippetId}/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of a code snippet to retrieve.
        in: path
        name: snippetId
        required: true
        schema:
          title: Snippetid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeSnippet'
          description: CodeSnippet represents a code snippet.
      summary: Retrieve Notebook Code Snippets by snippet ID
      tags:
      - notebooks
  /api/v2/notebookEnvironmentVariables/{notebookId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The notebook ID to delete all environment variables for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Notebook Environment Variables by notebook ID
      tags:
      - notebooks
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The notebook ID to list environment variables for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariablesResponseSchema'
          description: List environment variables response schema.
      summary: Retrieve Notebook Environment Variables by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The notebook ID to create environment variables for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentVariablesRequestSchema'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariablesResponseSchema'
          description: List environment variables response schema.
      summary: Create Notebook Environment Variables by notebook ID
      tags:
      - notebooks
  /api/v2/notebookEnvironmentVariables/{notebookId}/{envVarId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The notebook ID that the environment variable belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: The ID of the environment variable to delete.
        in: path
        name: envVarId
        required: true
        schema:
          title: Envvarid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete notebook environment variables by id
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The notebook ID that the environment variable belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: The ID of the environment variable to update.
        in: path
        name: envVarId
        required: true
        schema:
          title: Envvarid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewEnvironmentVariableSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentVariableSchema'
          description: Environment variable schema.
      summary: Modify Notebook Environment Variables by notebook ID
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/:
    get:
      deprecated: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentsResponse'
          description: Response schema for listing execution environments.
      summary: Retrieve Notebook Execution Environments
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/machines/:
    get:
      deprecated: false
      description: Returns all available environment machine options for which to
        run the notebook.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachinesPublic'
          description: Represents a list of machine types in the system.
      summary: Retrieve Machines
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/{environmentId}/notebooks/:
    get:
      deprecated: false
      description: Return list of notebooks that are using environment by environment
        ID.
      parameters:
      - deprecated: false
        description: Environment ID to get notebooks for.
        in: path
        name: environmentId
        required: true
        schema:
          title: Environmentid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for listing notebooks using a specific execution
          environment.
        in: query
        name: ExecutionEnvironmentUsageByNotebooksQuery
        required: false
        schema:
          $ref: '#/components/schemas/ExecutionEnvironmentUsageByNotebooksQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentUsageByNotebooksResponse'
          description: Response schema for listing notebooks using a specific execution
            environment.
      summary: Retrieve Notebooks by environment ID
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/{environmentId}/versions/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: Environment ID to get versions for.
        in: path
        name: environmentId
        required: true
        schema:
          title: Environmentid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionEnvironmentVersionsResponse'
          description: Response schema for listing execution environment versions.
      summary: List Notebook Execution Environments versions by environment ID
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/{notebookId}/:
    get:
      deprecated: false
      description: Return assigned execution environment as an EnvironmentPublic entity.
      parameters:
      - deprecated: false
        description: Notebook ID to get execution environment for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentPublic'
          description: The public representation of an execution environment.
      summary: Retrieve Notebook Execution Environments by notebook ID
      tags:
      - notebooks
    patch:
      deprecated: false
      description: Sets the environment configuration for the notebook.
      parameters:
      - deprecated: false
        description: Notebook ID to assign execution environment to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecutionEnvironmentAssignRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentPublic'
          description: The public representation of an execution environment.
      summary: Modify Notebook Execution Environments by notebook ID
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/{notebookId}/ports/:
    delete:
      deprecated: false
      description: Remove all exposed port for a given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID to delete all exposed ports for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Ports by notebook ID
      tags:
      - notebooks
    get:
      deprecated: false
      description: List all exposed ports for a given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID to get exposed ports for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExposedPortListSchema'
          description: List of exposed ports for a notebook.
      summary: Retrieve Ports by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: Notebook ID to create exposed port for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExposePortSchema'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExposedPortSchema'
          description: Exposed port schema for a notebook.
      summary: Create Ports by notebook ID
      tags:
      - notebooks
  /api/v2/notebookExecutionEnvironments/{notebookId}/ports/{portId}/:
    delete:
      deprecated: false
      description: Remove previously exposed port for a given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID for exposed port that is being deleted.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Port ID that is being deleted.
        in: path
        name: portId
        required: true
        schema:
          title: Portid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete ports by id
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: Notebook ID for exposed port that is being updated.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Port ID that is being updated.
        in: path
        name: portId
        required: true
        schema:
          title: Portid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExposedPortSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExposedPortSchema'
          description: Exposed port schema for a notebook.
      summary: Modify Ports by notebook ID
      tags:
      - notebooks
  /api/v2/notebookJobs/:
    get:
      deprecated: false
      description: Get scheduled jobs list.
      parameters:
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for listing scheduled jobs.
        in: query
        name: ListScheduledJobQuery
        required: false
        schema:
          $ref: '#/components/schemas/ListScheduledJobQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookScheduleJobsPaginated'
          description: Paginated response for notebook schedule jobs.
      summary: Retrieve Notebook jobs
      tags:
      - notebooks
    post:
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledJobRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookScheduleDefinition'
          description: Notebook schedule definition.
      summary: Create Notebook jobs
      tags:
      - notebooks
  /api/v2/notebookJobs/manualRun/:
    post:
      deprecated: false
      description: Create a manual run.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateManualRunRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookScheduleDefinition'
          description: Notebook schedule definition.
      summary: Create Manual Run
      tags:
      - notebooks
  /api/v2/notebookJobs/runHistory/:
    get:
      deprecated: false
      parameters:
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for listing scheduled runs history.
        in: query
        name: ListScheduledRunsHistoryQuery
        required: false
        schema:
          $ref: '#/components/schemas/ListScheduledRunsHistoryQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookScheduledRunsHistoryPaginated'
          description: Paginated response for notebook scheduled runs history.
      summary: Retrieve Run history
      tags:
      - notebooks
  /api/v2/notebookJobs/{notebookScheduleId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: Notebook Schedule ID to delete.
        in: path
        name: notebookScheduleId
        required: true
        schema:
          title: Notebookscheduleid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for deleting a scheduled job.
        in: query
        name: DeleteScheduledJobQuery
        required: false
        schema:
          $ref: '#/components/schemas/DeleteScheduledJobQuery'
      responses:
        '204':
          description: No content.
      summary: Delete Notebook jobs by notebook schedule ID
      tags:
      - notebooks
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: Notebook Schedule ID to fetch.
        in: path
        name: notebookScheduleId
        required: true
        schema:
          title: Notebookscheduleid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for a scheduled job.
        in: query
        name: ScheduledJobQuery
        required: false
        schema:
          $ref: '#/components/schemas/ScheduledJobQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookScheduleDefinition'
          description: Notebook schedule definition.
      summary: Retrieve Notebook jobs by notebook schedule ID
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: Notebook Schedule ID to update.
        in: path
        name: notebookScheduleId
        required: true
        schema:
          title: Notebookscheduleid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduledJobRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookScheduleDefinition'
          description: Notebook schedule definition.
      summary: Modify Notebook jobs by notebook schedule ID
      tags:
      - notebooks
  /api/v2/notebookJobs/{notebookScheduleId}/cancel/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: Notebook Schedule ID to cancel running jobs for.
        in: path
        name: notebookScheduleId
        required: true
        schema:
          title: Notebookscheduleid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for canceling scheduled jobs.
        in: query
        name: CancelScheduledJobsQuery
        required: false
        schema:
          $ref: '#/components/schemas/CancelScheduledJobsQuery'
      responses:
        '204':
          description: No content.
      summary: Cancel Notebook jobs by notebook schedule ID
      tags:
      - notebooks
  /api/v2/notebookRevisions/fromRevision/{notebookId}/{revisionId}/clone/:
    post:
      deprecated: false
      description: Clone a notebook from a revision.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to clone as notebook.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloneNotebookFromRevisionRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClonedNotebookResponse'
          description: Response schema for cloning a notebook from a revision.
      summary: Create Clone by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRevisions/fromRevision/{notebookId}/{revisionId}/restore/:
    post:
      deprecated: false
      description: Restore a notebook from a revision.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to restore notebook contents to.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      responses:
        '200':
          description: No content.
      summary: Create Restore by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRevisions/{notebookId}/:
    delete:
      deprecated: false
      description: Delete all revisions for the given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID to delete revisions for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Notebook Revisions by notebook ID
      tags:
      - notebooks
    get:
      deprecated: false
      description: List all revisions for the given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID to list revisions for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query schema for listing notebook revisions.
        in: query
        name: ListNotebookRevisionsQuerySchema
        required: false
        schema:
          $ref: '#/components/schemas/ListNotebookRevisionsQuerySchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotebookRevisionsResponse'
          description: Response schema for listing notebook revisions.
      summary: Retrieve Notebook Revisions by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      description: Create a new revision from the given notebook's current state.
      parameters:
      - deprecated: false
        description: Notebook ID to create a revision for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNotebookRevisionRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookRevisionSchema'
          description: Notebook revision schema.
      summary: Create Notebook Revisions by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRevisions/{notebookId}/{revisionId}/:
    delete:
      deprecated: false
      description: Delete single revision.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to delete.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete notebook revisions by id
      tags:
      - notebooks
    get:
      deprecated: false
      description: Get a specific revision for the given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to fetch.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionedNotebookSchema'
          description: Versioned notebook schema.
      summary: Retrieve notebook revisions by id
      tags:
      - notebooks
    patch:
      deprecated: false
      description: Update a revision's name.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to update.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotebookRevisionRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookRevisionSchema'
          description: Notebook revision schema.
      summary: Modify Notebook Revisions by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRevisions/{notebookId}/{revisionId}/cells/:
    get:
      deprecated: false
      description: Get cells for a specific revision version of the given notebook.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to fetch cells for.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NotebookCellCommonSchema'
                type: array
          description: Schema for notebook cell.
      summary: Retrieve Cells by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRevisions/{notebookId}/{revisionId}/toFile/:
    get:
      deprecated: false
      description: Export Notebook Revision to file.
      parameters:
      - deprecated: false
        description: Notebook ID associated with revision.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: Revision ID to export as file.
        in: path
        name: revisionId
        required: true
        schema:
          title: Revisionid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: Export notebook revision to file JSON response.
      summary: Retrieve To File by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/createAndStartCodespace/:
    post:
      deprecated: false
      description: Creates the Codespace and starts a session.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAndStartCodespaceSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSessionSchema'
          description: The schema for the notebook session.
      summary: Create And Start Codespace
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/:
    get:
      deprecated: false
      description: Retrieves the notebook session or returns the one in the default
        state.
      parameters:
      - deprecated: false
        description: The notebook ID to get session data for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSessionSchema'
          description: The schema for the notebook session.
      summary: Retrieve Notebooks by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/autocomplete/:
    post:
      deprecated: false
      description: Autocompletes code.
      parameters:
      - deprecated: false
        description: The notebook ID to run autocomplete for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeCompletionSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeCompletionResultSchema'
          description: The schema for the code completion result.
      summary: Create Autocomplete by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/cancel/:
    post:
      deprecated: false
      description: Cancels execution.
      parameters:
      - deprecated: false
        description: The notebook ID to cancel execution for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelExecutionRequest'
        required: false
      responses:
        '200':
          description: No content.
      summary: Cancel Notebooks by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/cells/{cellId}/dataframe/{referenceId}/:
    get:
      deprecated: false
      description: Gets a dataframe from a cell execution.
      parameters:
      - deprecated: false
        description: The notebook ID the dataframe belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: The cell ID the dataframe belongs to.
        in: path
        name: cellId
        required: true
        schema:
          title: Cellid
          type: string
      - deprecated: false
        description: The reference ID for the dataframe.
        in: path
        name: referenceId
        required: true
        schema:
          title: Referenceid
          type: integer
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Schema for query parameters for paginated requests.
        in: query
        name: SortedPaginationQuerySchema
        required: false
        schema:
          $ref: '#/components/schemas/SortedPaginationQuerySchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataframeResponse'
          description: Response schema for getting a dataframe from a notebook session.
      summary: Retrieve Dataframe by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/clientActivity/:
    post:
      deprecated: false
      description: Reset session TTL from client, when there is a user activity.
      parameters:
      - deprecated: false
        description: The notebook ID for which client activity is being acknowledged.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientActivityRequest'
        required: false
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
          description: Response schema indicating success of an operation.
      summary: Create Client Activity by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/dataframeList/:
    get:
      deprecated: false
      description: Lists all dataframes for a notebook.
      parameters:
      - deprecated: false
        description: The notebook ID to list dataframes for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataframesResponse'
          description: Response schema for listing DataFrames in a notebook session.
      summary: Retrieve Dataframe List by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/execute/:
    post:
      deprecated: false
      description: Executes specific cells or the entire notebook.
      parameters:
      - deprecated: false
        description: The notebook ID to execute cells for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteCellsRequest'
        required: false
      responses:
        '202':
          description: No content.
      summary: Execute Notebooks by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/executionStatus/:
    get:
      deprecated: false
      description: Gets execution status.
      parameters:
      - deprecated: false
        description: The notebook ID to get execution status for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutionStatusSchema'
          description: Schema for the execution status of a notebook session.
      summary: Retrieve Execution Status by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/inputReply/:
    post:
      deprecated: false
      description: Endpoint used in response to when the kernel requests input from
        the user.
      parameters:
      - deprecated: false
        description: The notebook ID receiving a user's reply to a corresponding request
          for input.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputReplySchema'
        required: false
      responses:
        '200':
          description: No content.
      summary: Create Input Reply by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/inspect/:
    post:
      deprecated: false
      description: Inspects code.
      parameters:
      - deprecated: false
        description: The notebook ID to run code inspection for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeInspectionSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeInspectionResultSchema'
          description: The schema for the code inspection result.
      summary: Create Inspect by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/restartKernel/:
    post:
      deprecated: false
      description: Restarts kernel.
      parameters:
      - deprecated: false
        description: The notebook ID to restart kernel for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          description: No content.
      summary: Create Restart Kernel by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/start/:
    post:
      deprecated: false
      description: Starts a new notebook session.
      parameters:
      - deprecated: false
        description: The notebook ID to start a session for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartNotebookSessionSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSessionSchema'
          description: The schema for the notebook session.
      summary: Start Notebooks by notebook ID
      tags:
      - notebooks
  /api/v2/notebookRuntimes/notebooks/{notebookId}/stop/:
    post:
      deprecated: false
      description: Stops the notebook session.
      parameters:
      - deprecated: false
        description: The notebook ID to stop session for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSessionSchema'
          description: The schema for the notebook session.
      summary: Stop Notebooks by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/download/:
    get:
      deprecated: false
      description: Download entire file system as an archive.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                type: string
          description: Download entire file system as an archive.
      summary: Retrieve Download by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/:
    get:
      deprecated: false
      description: Get paginated list of objects for a given path in the filesystem.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: We have set the limit max value to one thousand
        in: query
        name: ListFilesystemObjectsRequest
        required: false
        schema:
          $ref: '#/components/schemas/ListFilesystemObjectsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFilesystemObjectsResponse'
          description: Response schema for listing filesystem objects.
      summary: Retrieve Objects by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/copy/:
    post:
      deprecated: false
      description: Copy a filesystem object at a given path to a specific destination.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyFilesystemObjectRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FilesystemObjectSchema'
                type: array
          description: This schema is used for filesystem objects (files and directories)
            in the filesystem.
      summary: Create Copy by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/delete/:
    delete:
      deprecated: false
      description: Delete a filesystem object(s) from a list of paths.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFilesystemObjectsRequest'
        required: false
      responses:
        '204':
          description: No content.
      summary: Delete Delete by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/download/:
    get:
      deprecated: false
      description: Download many files or directories from the notebook session.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query schema for downloading filesystem objects.
        in: query
        name: DownloadFilesystemObjectsQuery
        required: false
        schema:
          $ref: '#/components/schemas/DownloadFilesystemObjectsQuery'
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                type: string
          description: Download many files or directories from the notebook session.
      summary: Retrieve download by id
      tags:
      - notebooks
    post:
      deprecated: false
      description: Download a file or directory from the notebook session.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadFilesystemObjectsRequest'
        required: false
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                type: string
          description: Download a file or directory from the notebook session.
      summary: Create Download by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/metadata/:
    get:
      deprecated: false
      description: Get the filesystem's metadata.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Request payload values for getting filesystem object metadata.
        in: query
        name: GetFilesystemObjectMetadataRequest
        required: false
        schema:
          $ref: '#/components/schemas/GetFilesystemObjectMetadataRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DRFilesystemMetadataResponse'
          description: Response schema for DataRobot filesystem metadata.
      summary: Retrieve Metadata by notebook ID
      tags:
      - notebooks
    patch:
      deprecated: false
      description: Update a filesystem object's metadata.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFilesystemObjectsMetadataRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/DRFileMetadata'
                type: array
          description: Metadata for DataRobot files.
      summary: Modify Metadata by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/move/:
    post:
      deprecated: false
      description: Move a filesystem object at a given path.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveFilesystemObjectRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FilesystemObjectSchema'
                type: array
          description: This schema is used for filesystem objects (files and directories)
            in the filesystem.
      summary: Create Move by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/new/:
    post:
      deprecated: false
      description: Create a new filesystem object (file or directory) at the given
        path.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFilesystemObjectRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilesystemObjectSchema'
          description: This schema is used for filesystem objects (files and directories)
            in the filesystem.
      summary: New by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/upload/:
    post:
      deprecated: false
      description: "Upload a file or directory into the notebook session and save\
        \ it under given path.\n    If file exists by given path, it will be overridden."
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FilesystemObjectSchema'
                type: array
          description: This schema is used for filesystem objects (files and directories)
            in the filesystem.
      summary: Create Upload by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/filesystem/objects/{subpath}/{path}/:
    get:
      deprecated: false
      description: 'Preview a file. The file path is passed as a parameter. For example:
        filesystem/objects/home/usr/storage/img.png/'
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: See method level description for details.
        in: path
        name: subpath
        required: true
        schema:
          title: subpath
          type: string
      - deprecated: false
        description: See method level description for details.
        in: path
        name: path
        required: true
        schema:
          title: path
          type: string
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                type: string
          description: Preview a file.
      summary: Retrieve objects by id
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/git/clone/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GitCloneRequest'
        required: false
      responses:
        '202':
          description: No content.
      summary: Create Clone by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/git/clone/cancel/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '201':
          description: No content.
      summary: Cancel Clone by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/git/clone/status/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitCloneStatusResponse'
          description: Response schema for the status of a Git clone operation.
      summary: Retrieve Status by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/KernelSchema'
                type: array
          description: The schema for the notebook kernel.
      summary: Retrieve Kernels by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartKernelRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KernelSchema'
          description: The schema for the notebook kernel.
      summary: Create Kernels by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to stop.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Kernels by notebook ID
      tags:
      - notebooks
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to retrieve.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KernelSchema'
          description: The schema for the notebook kernel.
      summary: Retrieve kernels by id
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/completion/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to use when requesting code completion.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeCompletionSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeCompletionResultSchema'
          description: The schema for the code completion result.
      summary: Create Completion by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/execute/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to use when executing code.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteCodeRequest'
        required: false
      responses:
        '200':
          description: No content.
      summary: Execute Kernels by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inputReply/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to send input request reply to.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputReplySchema'
        required: false
      responses:
        '200':
          description: No content.
      summary: Create Input Reply by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/inspect/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to inspect.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeInspectionSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeInspectionResultSchema'
          description: The schema for the code inspection result.
      summary: Create Inspect by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/interrupt/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to interrupt.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      responses:
        '200':
          description: No content.
      summary: Create Interrupt by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernels/{kernelId}/restart/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The kernel ID to restart.
        in: path
        name: kernelId
        required: true
        schema:
          title: Kernelid
          type: string
      responses:
        '200':
          description: No content.
      summary: Create Restart by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/kernelspecs/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KernelSpecsResponse'
          description: Schema for the Codespace's kernel information.
      summary: Retrieve Kernelspecs by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Base query schema for notebook operations.
        in: query
        name: NotebookOperationQuery
        required: false
        schema:
          $ref: '#/components/schemas/NotebookOperationQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookFileSchema'
          description: The schema for a .ipynb notebook as part of a Codespace.
      summary: Retrieve Notebook by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotebookOperationSchema'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NewNotebookFileSchema'
          description: The schema for the newly created notebook.
      summary: Create Notebook by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/activity/:
    post:
      deprecated: false
      description: "Reports that the client is still working with these notebooks.\n\
        \    UI uses it to report notebooks that are open and potentially viewed by\
        \ the user.\n    Knowing this information helps to shut down inactive notebook\
        \ reconcilers/executors."
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotebookActivityRequest'
        required: false
      responses:
        '204':
          description: No content.
      summary: Create Activity by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/cells/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Base schema for batch cell queries.
        in: query
        name: BatchCellQuery
        required: false
        schema:
          $ref: '#/components/schemas/BatchCellQuery'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionCreatedResponse'
          description: Base schema for action created responses.
      summary: Delete Cells by notebook ID
      tags:
      - notebooks
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Base query schema for getting notebook cells.
        in: query
        name: GetCellsQuery
        required: false
        schema:
          $ref: '#/components/schemas/GetCellsQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookCellsSchema'
          description: The schema for the notebook cells.
      summary: Retrieve Cells by notebook ID
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCellsRequest'
        required: false
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionCreatedResponse'
          description: Base schema for action created responses.
      summary: Modify Cells by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCellsRequest'
        required: false
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCellsResponse'
          description: Response schema for creating notebook cells.
      summary: Create Cells by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/cells/cancel/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelCellsExecutionRequest'
        required: false
      responses:
        '200':
          description: No content.
      summary: Cancel Cells by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/cells/output/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Base schema for batch cell queries.
        in: query
        name: BatchCellQuery
        required: false
        schema:
          $ref: '#/components/schemas/BatchCellQuery'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionCreatedResponse'
          description: Base schema for action created responses.
      summary: Delete Output by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/cells/reorder/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReorderCellsRequest'
        required: false
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionCreatedResponse'
          description: Base schema for action created responses.
      summary: Create Reorder by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/cells/{cellId}/move/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The cell ID to move.
        in: path
        name: cellId
        required: true
        schema:
          title: Cellid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveCellRequest'
        required: false
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionCreatedResponse'
          description: Base schema for action created responses.
      summary: Create move by id
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/dataframes/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Base query schema for notebook operations.
        in: query
        name: NotebookOperationQuery
        required: false
        schema:
          $ref: '#/components/schemas/NotebookOperationQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataFrameResponse'
          description: Schema for the list of DataFrames in a notebook.
      summary: Retrieve Dataframes by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/dataframes/{referenceId}/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The reference ID for the DataFrame.
        in: path
        name: referenceId
        required: true
        schema:
          title: Referenceid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query schema for paginated dataframe requests.
        in: query
        name: PaginatedDataframeQuery
        required: false
        schema:
          $ref: '#/components/schemas/PaginatedDataframeQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFrameResponseSchema'
          description: Schema for the DataFrame response.
      summary: Retrieve dataframes by id
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/execute/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteCellsRequest'
        required: false
      responses:
        '202':
          description: No content.
      summary: Execute Notebook by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/execution/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Base query schema for multiple notebook operations.
        in: query
        name: MultiNotebookOperationQuery
        required: false
        schema:
          $ref: '#/components/schemas/MultiNotebookOperationQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebooksExecutionStateResponse'
          description: Response schema for the notebooks execution state.
      summary: Retrieve Execution by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/kernel/:
    post:
      deprecated: false
      description: Sets kernel for a given notebook.
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignNotebookKernelRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KernelSchema'
          description: The schema for the notebook kernel.
      summary: Create Kernel by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/notebook/triggerExecution/:
    post:
      deprecated: false
      description: "A variation of execute_notebook that automatically prepares, assigns\
        \ kernel\n    and executes the notebook in its entirety."
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggeredNotebookExecutionRequest'
        required: false
      responses:
        '202':
          description: No content.
      summary: Create Trigger Execution by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/scripts/execute/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunFileRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteFileResponse'
          description: Response schema for executing a file.
      summary: Execute scripts by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/scripts/executing/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecutingFilesResponse'
          description: Response schema for listing executing files.
      summary: Retrieve Executing by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/terminals/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalsResponseSchema'
          description: Schema for the list of terminals in a notebook.
      summary: Retrieve Terminals by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTerminalSchema'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalSchema'
          description: Schema for a terminal.
      summary: Create Terminals by notebook ID
      tags:
      - notebooks
  /api/v2/notebookSessions/{notebookId}/terminals/{terminalId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The terminal ID to delete.
        in: path
        name: terminalId
        required: true
        schema:
          title: Terminalid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Terminals by notebook ID
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that the session belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: notebookId
          type: string
      - deprecated: false
        description: The terminal ID to update.
        in: path
        name: terminalId
        required: true
        schema:
          title: Terminalid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTerminalSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TerminalSchema'
          description: Schema for a terminal.
      summary: Modify Terminals by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/:
    get:
      deprecated: false
      description: Return list of notebooks.
      parameters:
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query options for listing notebooks in the notebooks directory.
        in: query
        name: ListNotebooksQuery
        required: false
        schema:
          $ref: '#/components/schemas/ListNotebooksQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNotebooksResponse'
          description: Response schema for listing notebooks.
      summary: Retrieve Notebooks
      tags:
      - notebooks
    post:
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNotebookRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSchema'
          description: Schema for notebook metadata with additional fields.
      summary: Create Notebooks
      tags:
      - notebooks
  /api/v2/notebooks/bulkLinkUseCase/:
    post:
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkLinkNotebooksToUseCaseRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
          description: Response schema indicating successful or failed operation.
      summary: Create Bulk Link Use Case
      tags:
      - notebooks
  /api/v2/notebooks/filterOptions/:
    get:
      deprecated: false
      parameters:
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query options for filtering notebooks in the notebooks directory.
        in: query
        name: FilterOptionsQuery
        required: false
        schema:
          $ref: '#/components/schemas/FilterOptionsQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterOptionsResponse'
          description: Response schema for filter options in the notebooks directory.
      summary: Retrieve Filter Options
      tags:
      - notebooks
  /api/v2/notebooks/fromFile/:
    post:
      deprecated: false
      description: Import Notebook from file endpoint.
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportNotebookResponse'
          description: Imported notebook information.
      summary: Create From File
      tags:
      - notebooks
  /api/v2/notebooks/fromUrl/:
    post:
      deprecated: false
      description: Import the notebook from the URL endpoint.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportNotebookFromUrlRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportNotebookResponse'
          description: Imported notebook information.
      summary: Create From URL
      tags:
      - notebooks
  /api/v2/notebooks/sharedRoles/:
    get:
      description: Get a lists of users who have access to each notebook and their
        roles on each respective notebook.
      operationId: notebooksSharedRoles_list
      parameters:
      - description: Comma separated notebook IDs to get info of.
        in: query
        name: notebookIds
        required: true
        schema:
          items:
            type: string
          maxItems: 100
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebooksSharedRolesListResponse'
          description: Access control list for each notebook keyed by notebook ID.
      summary: Get access control lists
      tags:
      - notebooks
      x-versionadded: v2.35
  /api/v2/notebooks/{notebookId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to delete.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Notebooks by notebook ID
      tags:
      - notebooks
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to retrieve.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSchema'
          description: Schema for notebook metadata with additional fields.
      summary: Retrieve Notebooks by notebook ID
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to update.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotebookRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSchema'
          description: Schema for notebook metadata with additional fields.
      summary: Modify Notebooks by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/batchClearCellsExecutionCount/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to batch clear cell execution count for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '204':
          description: No content.
      summary: Modify Batch Clear Cells Execution Count by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/:
    get:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to retrieve cells for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CellSchema'
                type: array
          description: Schema for notebook cell.
      summary: Retrieve Cells by notebook ID
      tags:
      - notebooks
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to create cells for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCellRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellSchema'
          description: Schema for notebook cell.
      summary: Create Cells by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/batchClearOutput/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to clear all cell output of.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchClearCellsOutputRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CellSchema'
                type: array
          description: Schema for notebook cell.
      summary: Modify Batch Clear Output by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/batchCreate/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to create cells for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateCellsRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CellSchema'
                type: array
          description: Schema for notebook cell.
      summary: Create Batch Create by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/batchDelete/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to batch delete cells for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDeleteCellsRequest'
        required: false
      responses:
        '204':
          description: No content.
      summary: Create Batch Delete by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/batchUpdateMetadata/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to batch update cell metadata for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdateCellsMetadataRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CellSchema'
                type: array
          description: Schema for notebook cell.
      summary: Modify Batch Update Metadata by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/batchUpdateSources/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to batch update cell sources for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdateCellsSourcesRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CellSchema'
                type: array
          description: Schema for notebook cell.
      summary: Modify Batch Update Sources by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/{cellId}/:
    delete:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook the cell belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: The ID of the cell to delete.
        in: path
        name: cellId
        required: true
        schema:
          title: Cellid
          type: string
      responses:
        '204':
          description: No content.
      summary: Delete Cells by notebook ID
      tags:
      - notebooks
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook the cell belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: The ID of the cell to update.
        in: path
        name: cellId
        required: true
        schema:
          title: Cellid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCellRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellSchema'
          description: Schema for notebook cell.
      summary: Modify Cells by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/cells/{cellId}/output/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook the cell belongs to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - deprecated: false
        description: The ID of the cell to clear output for.
        in: path
        name: cellId
        required: true
        schema:
          title: Cellid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClearCellOutputRequest'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CellSchema'
          description: Schema for notebook cell.
      summary: Modify Output by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/reorderCells/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to reorder cells for.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CellVersionActionSchema'
        required: false
      responses:
        '202':
          description: No content.
      summary: Modify Reorder Cells by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/sharedRoles/:
    get:
      description: Get a list of users and their roles who have access to this notebook.
      operationId: notebookSharedRoles_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: 0
          maximum: 100
          type: integer
      - description: The ID of the notebook.
        in: path
        name: notebookId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: The access control list for a notebook.
      summary: Get the notebook access control list by notebook ID
      tags:
      - notebooks
      x-versionadded: v2.35
  /api/v2/notebooks/{notebookId}/state/:
    patch:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook that cells belong to.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CellVersionActionSchema'
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CellSchema'
                type: array
          description: Schema for notebook cell.
      summary: Modify State by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/toCodespace/:
    post:
      deprecated: false
      parameters:
      - deprecated: false
        description: The ID of the notebook to convert to a codespace.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConvertToCodespaceRequest'
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotebookSchema'
          description: Schema for notebook metadata with additional fields.
      summary: Create To Codespace by notebook ID
      tags:
      - notebooks
  /api/v2/notebooks/{notebookId}/toFile/:
    get:
      deprecated: false
      description: Export Notebook to file endpoint.
      parameters:
      - deprecated: false
        description: The notebook ID to return as a file.
        in: path
        name: notebookId
        required: true
        schema:
          title: Notebookid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: Query parameters for exporting a notebook.
        in: query
        name: ExportNotebookQuerySchema
        required: false
        schema:
          $ref: '#/components/schemas/ExportNotebookQuerySchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: Export notebook to file JSON response.
      summary: Retrieve To File by notebook ID
      tags:
      - notebooks
  /api/v2/notificationChannelTemplates/:
    get:
      description: List the notification channel template according to the query.
      operationId: notificationChannelTemplates_list
      parameters:
      - description: The number of notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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-versionadded: v2.33
    post:
      description: Create a new notification channel template.
      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 a notification channel template.
      tags:
      - notifications
      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 a notification channel template by channel ID
      tags:
      - notifications
      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 a notification channel template by channel ID
      tags:
      - notifications
      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 a notification channel template by channel ID
      tags:
      - notifications
      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: The number of notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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 by channel ID
      tags:
      - notifications
      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: The number of notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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 by channel ID
      tags:
      - notifications
      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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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 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 the channel template access control list by channel ID
      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: The roles were 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 the channel template controls by channel ID
      tags:
      - notifications
      x-versionadded: v2.33
  /api/v2/notificationChannels/:
    get:
      description: List the notification channels according to the query.
      operationId: notificationChannels_list
      parameters:
      - description: The number of notification channels to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of notification channels to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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: The notification channels were 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: The notification channel was created successfully.
      summary: Create a 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: The notification channel was deleted successfully.
      summary: Delete a notification channel by channel ID
      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: The notification channel was retrieved successfully.
      summary: Retrieve a notification channel by channel ID
      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: The notification channel was updated successfully.
        '400':
          description: Email verification code is invalid.
      summary: Update a notification channel by channel ID
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationEmailChannelVerification/:
    post:
      description: Send a 6-digit verification code to the 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: Send a 6-digit verification code
      tags:
      - notifications
      x-versionadded: v2.21
  /api/v2/notificationEmailChannelVerificationStatus/:
    post:
      description: Retrieve the status of whether the admin entered the 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 the admin entered the code correctly.
      tags:
      - notifications
      x-versionadded: v2.21
  /api/v2/notificationEvents/:
    get:
      description: The list of 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 the list of
        the events available to the user.
      operationId: notificationEvents_list
      parameters:
      - description: The type of the related entity.
        in: query
        name: relatedEntityType
        required: false
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          - customjob
          - Customjob
          - CUSTOMJOB
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationEventListResponse'
          description: The event types and groups selectable for notification policies.
      summary: The list of event types and groups the user can include
      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 100, minimum 1, maximum
          1000.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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: 0
          maximum: 1000
          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
          - dataset.all
          - file.all
          - comment.all
          - invite_job.all
          - deployment_prediction_explanations_computation.all
          - model_deployments.critical_health
          - model_deployments.critical_frequent_health_change
          - model_deployments.frequent_health_change
          - model_deployments.health
          - model_deployments.retraining_policy
          - 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
          - use_case.all
          - batch_predictions.all
          - change_requests.all
          - custom_job_run.all
          - custom_job_run.unsuccessful
          - 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 a 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 a notification policy by policy ID
      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 a notification policy by policy ID
      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 a notification policy by policy ID
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notificationPolicyMutes/:
    get:
      description: The list of the ignored notifications filtered by org ID 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 100, minimum 1, maximum
          1000.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          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: The list of the ignored notifications filtered by org ID 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:
        '201':
          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:
        '204':
          description: ''
      summary: Delete the existing notification policy mute by mute ID
      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 the 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 ID 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 the status of the notification channel test by notification
        ID
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/notifications/:
    post:
      description: Resend the notification.
      operationId: notifications_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationResend'
      responses:
        '201':
          description: ''
      summary: Resend the notification.
      tags:
      - notifications
      x-versionadded: v2.20
  /api/v2/ocrJobResources/:
    get:
      description: Retrieve user's OCR job resources.
      operationId: ocrJobResources_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
          exclusiveMinimum: 0
          maximum: 1000
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OCRJobResourceListResponse'
          description: The OCR job resources.
      summary: Retrieve user's OCR job resources.
      tags:
      - features
      x-versionadded: v2.35
    post:
      description: Create an OCR job resource. This creates several entities, including
        an empty Dataset for writing the results and associates the input dataset
        with them.
      operationId: ocrJobResources_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OCRJobCreationRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OCRJobResourceResponse'
          description: The OCR job resource.
        '202':
          description: An OCR job resource is successfully created.
        '403':
          description: User doesn't have permission to access the dataset associated
            with the OCR job resource.
        '404':
          description: The OCR input dataset was not found.
        '422':
          description: The language parameter in the request is invalid.
      summary: Create an OCR job resource.
      tags:
      - features
      x-versionadded: v2.35
  /api/v2/ocrJobResources/{jobResourceId}/:
    get:
      description: Retrieve an OCR job resource.
      operationId: ocrJobResources_retrieve
      parameters:
      - description: The OCR job resource ID.
        in: path
        name: jobResourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OCRJobResourceResponse'
          description: The OCR job resource.
        '404':
          description: OCR job resource is not found for the requested job resource
            ID.
      summary: Retrieve an OCR job resource by job resource ID
      tags:
      - features
      x-versionadded: v2.35
  /api/v2/ocrJobResources/{jobResourceId}/errorReport/:
    get:
      description: Download the OCR job error report.
      operationId: ocrJobResourcesErrorReport_list
      parameters:
      - description: The OCR job resource ID.
        in: path
        name: jobResourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The OCR job error report.
        '404':
          description: OCR job error report is not found for the requested OCR job
            resource ID.
      summary: Retrieve the OCR job error report by job resource ID
      tags:
      - features
      x-versionadded: v2.35
    put:
      description: Upload the job error report to the associated OCR job resource
        for later downloading.
      operationId: ocrJobResourcesErrorReport_putMany
      parameters:
      - description: The OCR job resource ID.
        in: path
        name: jobResourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OCRJobErrorReportPutRequest'
      responses:
        '200':
          description: ''
        '403':
          description: User doesn't have permission to save error report.
        '404':
          description: Dataset with which the error report is associated is not found.
      summary: Save the OCR job error report by job resource ID
      tags:
      - features
      x-versionadded: v2.35
  /api/v2/ocrJobResources/{jobResourceId}/jobStatus/:
    get:
      description: Get the status of a running OCR job from the OCR service.
      operationId: ocrJobResourcesJobStatus_list
      parameters:
      - description: The OCR job resource ID.
        in: path
        name: jobResourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OCRJobStatusesResponse'
          description: The OCR job status.
        '404':
          description: OCR job resource is not found for the requested job resource
            ID.
      summary: Retrieve OCR job status by job resource ID
      tags:
      - features
      x-versionadded: v2.35
  /api/v2/ocrJobResources/{jobResourceId}/start/:
    post:
      description: Start an OCR job from the information in the OCR job resource.
        Each OCR job may be started exactly once.
      operationId: ocrJobResourcesStart_create
      parameters:
      - description: The OCR job resource ID.
        in: path
        name: jobResourceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OCRJobPostPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OCRJobPostResponse'
          description: The OCR job info.
        '202':
          description: An OCR job is successfully created.
        '404':
          description: The job resource was not found.
        '422':
          description: The OCR job is already started.
      summary: Create/start OCR job by job resource ID
      tags:
      - features
      x-versionadded: v2.35
  /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: 0
          maximum: 1000
          type: integer
      - description: Query for organizations with these IDs.
        in: query
        name: id
        required: false
        schema:
          items:
            type: string
          maxItems: 100
          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 an organization by organization ID
      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 by organization ID
      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: Query for users with these IDs.
        in: query
        name: ids
        required: false
        schema:
          items:
            type: string
          maxItems: 100
          type: array
        x-versionadded: v2.36
      - 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 by organization ID
      tags:
      - user_management
      x-versionadded: v2.0
    post:
      description: Add user to an existing organization. A user can only be part of
        one organization.
      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 by organization ID
      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 a user by organization ID
      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 an organization user by organization ID
      tags:
      - user_management
      x-versionadded: v2.0
  /api/v2/otel/stats/:
    get:
      operationId: otelStats_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: Service name, or list of service names, of the process.
        in: query
        name: serviceName
        required: false
        schema:
          oneOf:
          - description: Service name of the process
            type: string
          - items:
              description: Service name of the process
              type: string
            maxItems: 100
            type: array
      - description: User IDs to view (must be admin to use this field).
        in: query
        name: userId
        required: false
        schema:
          oneOf:
          - description: ID of the user.
            type: string
          - items:
              description: ID of the user.
              type: string
            maxItems: 100
            type: array
      - description: The start time of the trace
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time of the trace
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelStatsResponse'
          description: ''
      summary: Gets OTel statistics
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.43
  /api/v2/otel/{entityType}/{entityId}/logs/:
    delete:
      operationId: otelLogs_deleteMany
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the logs belong.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the logs belong.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: User does not have permission to delete OpenTelemetry logs.
      summary: Delete all OpenTelemetry logs by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.42
    get:
      operationId: otelLogs_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The minimum log level of logs to include.
        in: query
        name: level
        required: false
        schema:
          default: debug
          enum:
          - debug
          - info
          - warn
          - warning
          - error
          - critical
          type: string
      - description: The list of strings that must be included in the log entry.
        in: query
        name: includes
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of values that must be excluded from the log entry.
        in: query
        name: excludes
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The OTel span ID the logs must be associated with (if any).
        in: query
        name: spanId
        required: false
        schema:
          type: string
      - description: The OTel trace ID the logs must be associated with (if any).
        in: query
        name: traceId
        required: false
        schema:
          type: string
      - description: The type of the entity to which the logs belong.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the logs belong.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelLoggingListResponse'
          description: ''
      summary: Retrieve OpenTelemetry logs by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.39
  /api/v2/otel/{entityType}/{entityId}/logs/podInfo/:
    get:
      description: List pods and containers found in OpenTelemetry logs of the specified
        entity.
      operationId: otelLogsPodInfo_list
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the logs belong.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the logs belong.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelPodsInfoResponse'
          description: ''
      summary: List pods and containers found by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.46
  /api/v2/otel/{entityType}/{entityId}/metrics/:
    delete:
      operationId: otelMetrics_deleteMany
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Delete all OpenTelemetry metrics by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.42
  /api/v2/otel/{entityType}/{entityId}/metrics/autocollectedValues/:
    get:
      description: Get aggregated values of OpenTelemetry metrics that DataRobot automatically
        collects for the specified entity.
      operationId: otelMetricsAutocollectedValues_list
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricAutocollectedValuesResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get aggregated values of OpenTelemetry metrics that DataRobot automatically
        collects by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.39
  /api/v2/otel/{entityType}/{entityId}/metrics/configs/:
    get:
      description: List the OpenTelemetry metric configurations for the specified
        entity.
      operationId: otelMetricsConfigs_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricConfigListResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: List the OpenTelemetry metric configurations by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
    post:
      description: Create an OpenTelemetry metric configuration for the specified
        entity.
      operationId: otelMetricsConfigs_create
      parameters:
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtelMetricConfigCreatePayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricConfigObject'
          description: The resource was created.
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Create an OpenTelemetry metric configuration by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
    put:
      description: Set all the OpenTelemetry metric configurations for the specified
        entity.
      operationId: otelMetricsConfigs_putMany
      parameters:
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtelMetricConfigSetPayload'
      responses:
        '204':
          description: The metric configurations were set.
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Set all the OpenTelemetry metric configurations by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
  /api/v2/otel/{entityType}/{entityId}/metrics/configs/{otelMetricId}/:
    delete:
      description: Delete an OpenTelemetry metric configuration for the specified
        entity.
      operationId: otelMetricsConfigs_delete
      parameters:
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The ID of the OpenTelemetry metric configuration.
        in: path
        name: otelMetricId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Delete an OpenTelemetry metric configuration by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
    get:
      description: Get an OpenTelemetry metric configuration for the specified entity.
      operationId: otelMetricsConfigs_retrieve
      parameters:
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The ID of the OpenTelemetry metric configuration.
        in: path
        name: otelMetricId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricConfigObject'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get the OpenTelemetry metric configuration by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
    patch:
      description: Update an OpenTelemetry metric configuration for the specified
        entity.
      operationId: otelMetricsConfigs_patch
      parameters:
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The ID of the OpenTelemetry metric configuration.
        in: path
        name: otelMetricId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtelMetricConfigUpdatePayload'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricConfigObject'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Update an OpenTelemetry metric configuration by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
  /api/v2/otel/{entityType}/{entityId}/metrics/consumers/:
    get:
      description: Retrieve list of unique agents/users that have made requests to
        this resource. Only available to resource owners and users with read permissions.
      operationId: otelMetricsConsumers_list
      parameters:
      - description: The type of the entity to which the metrics belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - workload
          type: string
      - description: The ID of the entity to which the metrics belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumersResponse'
          description: Resource consumer information retrieved.
      summary: Retrieve resource consumers by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.45
  /api/v2/otel/{entityType}/{entityId}/metrics/podInfo/:
    get:
      description: List pods and containers found in OpenTelemetry metrics of the
        specified entity.
      operationId: otelMetricsPodInfo_list
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelPodsInfoResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Retrieve pod info by id
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.39
  /api/v2/otel/{entityType}/{entityId}/metrics/summary/:
    get:
      description: List reported OpenTelemetry metrics of the specified entity.
      operationId: otelMetricsSummary_list
      parameters:
      - description: Only show reported metrics whose name contains this string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Only show reported metrics of this type.
        in: query
        name: metricType
        required: false
        schema:
          type: string
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricSummaryResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: List reported OpenTelemetry metrics of the specified entity by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
  /api/v2/otel/{entityType}/{entityId}/metrics/valueOverTime/:
    get:
      description: Get a single OpenTelemetry metric value of the specified entity
        over time.
      operationId: otelMetricsValueOverTime_list
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The period for values of the metric list.
        in: query
        name: resolution
        required: false
        schema:
          default: PT1H
          enum:
          - PT1M
          - PT5M
          - PT1H
          - P1D
          - P7D
          type: string
      - description: The OTel key of the metric.
        in: query
        name: otelName
        required: true
        schema:
          maxLength: 255
          type: string
      - description: The aggregation method used for metric display.
        in: query
        name: aggregation
        required: true
        schema:
          enum:
          - sum
          - average
          - min
          - max
          - cardinality
          - percentiles
          - histogram
          type: string
      - description: The unit of measurement for the metric.
        in: query
        name: units
        required: false
        schema:
          type:
          - string
          - 'null'
      - description: The display name of the metric.
        in: query
        name: displayName
        required: false
        schema:
          maxLength: 127
          type:
          - string
          - 'null'
      - description: The metric percentile for the percentile aggregation of histograms.
        in: query
        name: percentile
        required: false
        schema:
          exclusiveMinimum: 0.0
          maximum: 1.0
          type:
          - number
          - 'null'
      - description: The bucket size used for histogram aggregation.
        in: query
        name: bucketInterval
        required: false
        schema:
          exclusiveMinimum: 0.0
          type:
          - number
          - 'null'
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelSingleMetricValueOverTimeResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get a single OpenTelemetry metric value of the specified entity over
        time by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
  /api/v2/otel/{entityType}/{entityId}/metrics/values/:
    get:
      description: Get OpenTelemetry metrics values of the specified entity over a
        single time period.
      operationId: otelMetricsValues_list
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: Return histograms as buckets instead of percentile values.
        in: query
        name: histogramBuckets
        required: false
        schema:
          default: 'false'
          enum:
          - 'false'
          - 'False'
          - 'true'
          - 'True'
          type: string
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricAggregatedValuesResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get OpenTelemetry metrics values of the specified entity over a single
        time by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
  /api/v2/otel/{entityType}/{entityId}/metrics/values/segments/{segmentAttribute}/:
    get:
      description: Get OpenTelemetry metric values for the specified entity, grouped
        by the segment attribute name and values over a single time period.
      operationId: otelMetricsValuesSegments_retrieve
      parameters:
      - description: The values for grouping metrics by segment.
        in: query
        name: segmentValue
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 50
            minItems: 1
            type: array
      - description: The maximum number of segment values to return when segmentValues
          is not provided.
        in: query
        name: segmentLimit
        required: false
        schema:
          maximum: 50
          minimum: 1
          type: integer
      - description: The OTel key of the metric.
        in: query
        name: otelName
        required: false
        schema:
          oneOf:
          - maxLength: 255
            type: string
          - items:
              maxLength: 255
              type: string
            maxItems: 10
            minItems: 1
            type: array
      - description: The aggregation method used for metric display.
        in: query
        name: aggregation
        required: false
        schema:
          oneOf:
          - enum:
            - sum
            - average
            - min
            - max
            - cardinality
            - percentiles
            - histogram
            type: string
          - items:
              enum:
              - sum
              - average
              - min
              - max
              - cardinality
              - percentiles
              - histogram
              type: string
            maxItems: 10
            minItems: 1
            type: array
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The name of the attribute by which to group results.
        in: path
        name: segmentAttribute
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricAggregatedValuesSegmentedResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get OpenTelemetry metric values, grouped by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.4
  /api/v2/otel/{entityType}/{entityId}/metrics/valuesOverTime/:
    get:
      description: Get OpenTelemetry configured metrics values of the specified entity
        over time.
      operationId: otelMetricsValuesOverTime_list
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The period for values of the metric list.
        in: query
        name: resolution
        required: false
        schema:
          default: PT1H
          enum:
          - PT1M
          - PT5M
          - PT1H
          - P1D
          - P7D
          type: string
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricValuesOverTimeResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get OpenTelemetry configured metrics values of the specified entity
        over time by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.41
  /api/v2/otel/{entityType}/{entityId}/metrics/valuesOverTime/segments/:
    post:
      description: Get OpenTelemetry metric values for the specified entity, grouped
        by multiple attributes.
      operationId: otelMetricsValuesOverTimeSegments_create
      parameters:
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OtelMetricValuesOverTimeSegmentByMultipleAttrsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricValuesOverTimeSegmentByMultipleAttrsResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get OpenTelemetry metric values by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.39
  /api/v2/otel/{entityType}/{entityId}/metrics/valuesOverTime/segments/{segmentAttribute}/:
    get:
      description: Get OpenTelemetry metric values for the specified entity, grouped
        by the segment attribute name and values.
      operationId: otelMetricsValuesOverTimeSegments_retrieve
      parameters:
      - description: The values for grouping metrics by segment.
        in: query
        name: segmentValue
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 50
            minItems: 1
            type: array
      - description: The maximum number of segment values to return when segmentValues
          is not provided.
        in: query
        name: segmentLimit
        required: false
        schema:
          maximum: 50
          minimum: 1
          type: integer
      - description: The OTel key of the metric.
        in: query
        name: otelName
        required: false
        schema:
          oneOf:
          - maxLength: 255
            type: string
          - items:
              maxLength: 255
              type: string
            maxItems: 10
            minItems: 1
            type: array
      - description: The aggregation method used for metric display.
        in: query
        name: aggregation
        required: false
        schema:
          oneOf:
          - enum:
            - sum
            - average
            - min
            - max
            - cardinality
            - percentiles
            - histogram
            type: string
          - items:
              enum:
              - sum
              - average
              - min
              - max
              - cardinality
              - percentiles
              - histogram
              type: string
            maxItems: 10
            minItems: 1
            type: array
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The period for values of the metric list.
        in: query
        name: resolution
        required: false
        schema:
          default: PT1H
          enum:
          - PT1M
          - PT5M
          - PT1H
          - P1D
          - P7D
          type: string
      - description: The type of the entity to which the metric belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the metric belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The name of the attribute by which to group results.
        in: path
        name: segmentAttribute
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OtelMetricSegmentedValueResponse'
          description: ''
        '403':
          description: User does not have permission to access OpenTelemetry metrics.
      summary: Get OpenTelemetry metric values, grouped by segment attribute by entitytype
      tags:
      - data_exports_and_tracing
      x-versionadded: v2.4
  /api/v2/otel/{entityType}/{entityId}/traces/:
    delete:
      operationId: otelTraces_deleteMany
      parameters:
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The type of the entity to which the trace belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the trace belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Delete OpenTelemetry traces by entitytype
      tags:
      - data_exports_and_tracing
      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.42
    get:
      operationId: tracing_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The start time to filter data by.
        in: query
        name: startTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The end time to filter data by.
        in: query
        name: endTime
        required: false
        schema:
          format: date-time
          type: string
      - description: The list of search keys.
        in: query
        name: searchKeys
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The list of search values.
        in: query
        name: searchValues
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 10
            type: array
      - description: The minimum duration of the span in nanoseconds.
        in: query
        name: minSpanDuration
        required: false
        schema:
          type: integer
      - description: The maximum duration of the span in nanoseconds.
        in: query
        name: maxSpanDuration
        required: false
        schema:
          type: integer
      - description: The minimum duration of the trace in nanoseconds.
        in: query
        name: minTraceDuration
        required: false
        schema:
          type: integer
      - description: The minimum cost of the trace.
        in: query
        name: minTraceCost
        required: false
        schema:
          type: integer
      - description: The maximum cost of the trace.
        in: query
        name: maxTraceCost
        required: false
        schema:
          type: integer
      - description: Filter by root span name. Accepts a single value or a list of
          values.
        in: query
        name: rootSpanName
        required: false
        schema:
          oneOf:
          - maxLength: 200
            minLength: 1
            type: string
          - items:
              maxLength: 200
              minLength: 1
              type: string
            maxItems: 50
            type: array
      - description: Filter traces by status. Use 'error' to return only traces with
          at least one error span, or 'ok' to return only traces with no error spans.
        in: query
        name: status
        required: false
        schema:
          enum:
          - error
          - ok
          type: string
      - description: 'Field to sort traces by. One of: ''timestamp'', ''duration'',
          ''cost''. Defaults to ''timestamp''.'
        in: query
        name: sortBy
        required: false
        schema:
          enum:
          - timestamp
          - duration
          - cost
          type: string
      - description: 'Sort direction. One of: ''asc'', ''desc''. Defaults to ''desc''.'
        in: query
        name: sortDirection
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
      - description: Filter traces by trace type. Currently supports only 'gen_ai'.
        in: query
        name: traceType
        required: false
        schema:
          enum:
          - gen_ai
          type: string
      - description: Filter by gen_ai.tool.name. Repeat the query parameter for each
          tool name (up to 50 names, each at most 100 characters). Returns traces
          that include at least one span using any of the listed tools.
        in: query
        name: tools
        required: false
        schema:
          oneOf:
          - maxLength: 100
            minLength: 1
            type: string
          - items:
              maxLength: 100
              minLength: 1
              type: string
            maxItems: 50
            minItems: 1
            type: array
      - description: The type of the entity to which the trace belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the trace belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TracingListResponse'
          description: ''
      summary: List OpenTelemetry traces by entitytype
      tags:
      - data_exports_and_tracing
      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.38
  /api/v2/otel/{entityType}/{entityId}/traces/{traceId}/:
    get:
      operationId: tracing_retrieve
      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: 0
          type: integer
      - description: The type of the entity to which the trace belongs.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - use_case
          - experiment_container
          - custom_application
          - workload
          type: string
      - description: The ID of the entity to which the trace belongs.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The OTel trace ID.
        in: path
        name: traceId
        required: true
        schema:
          maxLength: 32
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TracingRetrieveResponse'
          description: ''
      summary: Retrieve the specified OpenTelemetry trace by entitytype
      tags:
      - data_exports_and_tracing
      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.38
  /api/v2/overallModerationConfiguration/:
    get:
      description: Get the overall moderation configuration for an entity.
      operationId: overallModerationConfiguration_list
      parameters:
      - description: Retrieve the overall moderation configuration for the given entity
          ID.
        in: query
        name: entityId
        required: true
        schema:
          type: string
      - description: The entity type of the given entity ID.
        in: query
        name: entityType
        required: true
        schema:
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverallModerationConfigurationResponse'
          description: ''
        '404':
          description: User permissions problem.
      summary: Get the overall moderation configuration
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
    patch:
      description: Update the overall moderation configuration for an entity.
      operationId: overallModerationConfiguration_patchMany
      parameters:
      - description: Retrieve the overall moderation configuration for the given entity
          ID.
        in: path
        name: entityId
        required: true
        schema:
          type: string
      - description: The entity type of the given entity ID.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - customModel
          - customModelVersion
          - playground
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OverallModerationConfigurationUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OverallModerationConfigurationResponse'
          description: ''
        '404':
          description: Either the resource does not exist or the user does not have
            permission to create the configuration.
      summary: Update the overall moderation configuration
      tags:
      - guardrails
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Configure and use guardrails for LLM intervention and moderation.
        enabled_by_default: false
        maturity: GA_PREMIUM
        name: MODERATION_GUARDRAILS
      x-versionadded: v2.35
  /api/v2/pinnedUsecases/:
    get:
      operationId: pinnedUsecases_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PinnedUsecasesResponse'
          description: Pinned Use Cases retrieved successfully.
        '403':
          description: User does not have access to this functionality.
      summary: Retrieve Pinned Usecases
      tags:
      - use_cases
      x-versionadded: v2.36
    patch:
      operationId: pinnedUsecases_patchMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PinnedUsecaseUpdatePayload'
      responses:
        '204':
          description: Pinned Use Cases retrieved successfully.
        '403':
          description: User does not have access to this functionality.
      summary: Modify Pinned Usecases
      tags:
      - use_cases
      x-versionadded: v2.36
  /api/v2/predictionServers/:
    get:
      description: The list of 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: 0
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PredictionServerListResponse'
          description: ''
      summary: List prediction servers.
      tags:
      - predictions_info
      x-versionadded: v2.17
  /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: The 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 by status ID
      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: The permadelete job status with details per project.
      summary: Retrieve project permadelete job status by status ID
      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/ProjectNukeReportDownloadResponse'
          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 by status ID
      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 by status ID
      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 a 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 by project ID
      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 by project ID
      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 a project by project ID
      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 the project access control list by project ID
      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 the project's access controls by project ID
      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 by project ID
      tags:
      - projects
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/anomalyAssessmentRecords/:
    get:
      description: Retrieve anomaly assessment records.
      operationId: projectsAnomalyAssessmentRecords_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      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: The request was received.
      summary: Pause by project ID
      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 by project ID
      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
        by project ID
      tags:
      - features
      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: The 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 by project
        ID
      tags:
      - features
      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: 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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      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 by project ID
      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 by project
        ID
      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: 0
          maximum: 1000
          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: The list of calendar events.
      summary: List available calendar events by project ID
      tags:
      - features
      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: The 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: 0
          maximum: 1000
          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 by project ID
      tags:
      - datarobot_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 the 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 by project ID
      tags:
      - datarobot_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: The 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: 0
          maximum: 1000
          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 the 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 by project ID
      tags:
      - datarobot_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 the 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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - features
      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: Search query for data slices.
        in: query
        name: searchQuery
        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/DataSlicesListAllSlicesResponse'
          description: List of data slices for the project was successfully retrieved.
      summary: List paginated Data Slices by project ID
      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: The 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: 0
          maximum: 1000
          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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      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
      - 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/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 by project ID
      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 by project ID
      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 anomaly over time plots by id
      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
      - 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/AnomalyOverTimePlotsMetadataResponse'
          description: Anomaly over Time insight metadata.
        '404':
          description: Anomaly over Time insight metadata was not found.
        '422':
          description: Invalid parameters were submitted.
      summary: Retrieve metadata by id
      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: 0
          maximum: 1
          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 preview by id
      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
        by project ID
      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 by project ID
      tags:
      - datarobot_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: 0
          maximum: 1000
          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 that was used to compute the AOT chart.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID that was used to compute the AOT chart.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset ID that 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 by project ID
      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 that was used to compute the AOT chart.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID that was used to compute the AOT chart.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset ID that 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 by project
        ID
      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 that was used to compute the AOT chart.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      - description: The model ID that was used to compute the AOT chart.
        in: path
        name: modelId
        required: true
        schema:
          type: string
      - description: The dataset ID that 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 by project
        ID
      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 by project ID
      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: The model's 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 by project ID
      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 by project ID
      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: The project or model does not exist.
        '422':
          description: The model is not datetime partitioned.
      summary: Retrieve Feature Effects metadata for each backtest by project ID
      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
        by project ID
      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 forecast vs actual plots by id
      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
      - 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/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 metadata by id
      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 preview by id
      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: The model's 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 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: 0
          maximum: 1000
          type: integer
      - description: Target class label.
        in: query
        name: class
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      tags:
      - projects
      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: The 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 by project ID
      tags:
      - projects
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - features
      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: The 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 by project ID
      tags:
      - features
      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: The 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: 0
          maximum: 1000
          type: integer
      - description: The 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 by
        project ID
      tags:
      - features
      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: 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 by project ID
      tags:
      - features
      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: 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 by project ID
      tags:
      - features
      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
          - type: 'null'
      - 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
          - type: 'null'
      - 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
          - type: 'null'
      - 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 by project ID
      tags:
      - features
      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: 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 by project ID
      tags:
      - features
      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: The 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 by project
        ID
      tags:
      - features
      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: 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 by project ID
      tags:
      - features
      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: The Eureqa model details plot.
        '404':
          description: Data was not found.
      summary: Retrieve Eureqa model details plot by project ID
      tags:
      - datarobot_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: The Eureqa model details plot.
        '404':
          description: Data was not found.
      summary: Retrieve eureqa model detail by id
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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: The Pareto front for the Eureqa model.
        '404':
          description: Data was not found.
      summary: Retrieve the pareto front by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.13
  /api/v2/projects/{projectId}/externalScores/:
    get:
      description: The list of scores on prediction datasets for a project with filtering
        option by dataset, model, or both. A 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: The 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: 0
          maximum: 1000
          type: integer
      - description: If provided, will return scores for the dataset with the matching
          dataset ID.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: If provided, will return scores for the model with the matching
          model ID.
        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: The list of scores on prediction datasets.
        '404':
          description: The project was not found.
      summary: The list of scores on prediction datasets by project ID
      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 by project ID
      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 the external time series baseline validation
            job.
      summary: Validate baseline data by project ID
      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 the baseline validation job by project ID
      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 by project ID
      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: The feature association matrix for the project.
        '404':
          description: Wrong query parameters specified or no such `projectId` exists.
        '422':
          description: The project does not support feature associations.
      summary: Retrieve pairwise feature association statistics by project ID
      tags:
      - insights
      x-versionadded: v2.17
    post:
      description: Compute the feature association matrix for the 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 the feature association matrix by project ID
      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 by project ID
      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 by project ID
      tags:
      - features
      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: The 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: 0
          maximum: 1000
          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 by project ID
      tags:
      - features
      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 by project
        ID
      tags:
      - features
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/featureDiscoveryRecipeSQLs/download/:
    get:
      description: Download the 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: Determines whether to download the file or just return text.
        in: query
        name: asText
        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 the feature discovery SQL recipe by project ID
      tags:
      - features
      x-versionadded: v2.25
  /api/v2/projects/{projectId}/featureDiscoveryRecipeSqlExports/:
    post:
      description: Generate the 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 the feature discovery SQL recipe by project ID
      tags:
      - features
      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: The 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 the feature histogram by project ID
      tags:
      - features
      x-versionadded: v2.14
  /api/v2/projects/{projectId}/featureLineages/{featureLineageId}/:
    get:
      description: Retrieve the Feature Discovery lineage for a single feature.
      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 the Feature Discovery lineage by project ID
      tags:
      - features
      x-versionadded: v2.23
  /api/v2/projects/{projectId}/featurelists/:
    get:
      description: List all featurelists for a project.
      operationId: projectsFeaturelists_list
      parameters:
      - description: The 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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 a project feature by project ID
      tags:
      - features
      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: The project ID.
        in: path
        name: projectId
        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/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: The feature is not numeric.
      summary: Retrieve the frequent values information by project ID
      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 as 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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - datarobot_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: The list of frozen models in the project.
        '404':
          description: This resource does not exist.
      summary: List all frozen models by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      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: The map of one location feature.
        '404':
          description: Map of feature not found
      summary: Retrieve a map of one location feature by project ID
      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 by project ID
      tags:
      - insights
      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: 0
          type: integer
      - description: The 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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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: 0
          type: integer
      - description: The 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: Retrieve image samples by id
      tags:
      - features
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/images/:
    get:
      description: Returns a list of image metadata elements.
      operationId: projectsImages_list
      parameters:
      - description: The 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
          - type: 'null'
      - 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
          - type: 'null'
      - 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
          - type: 'null'
      - description: The number of results to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of results to return.
        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 by project ID
      tags:
      - features
      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: The 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 by project ID
      tags:
      - features
      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: The 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: Retrieve file by id
      tags:
      - features
      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: 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 by project ID
      tags:
      - features
      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 by project
        ID
      tags:
      - features
      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.
      feature_flags:
      - &id010
        description: Enables Incremental Learning. This allows model retraining to
          continue with an infinite amount of data.
        enabled_by_default: true
        maturity: PUBLIC_PREVIEW
        name: INCREMENTAL_LEARNING
      maturity: PUBLIC_PREVIEW
      operationId: projectsIncrementalLearningModelsFromModel_create
      parameters:
      - description: The project ID.
        in: path
        name: projectId
        required: true
        schema:
          type: string
      public_preview: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrainIncrementalLearningModel'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelRetrainResponse'
          description: The 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 by project ID
      tags:
      - datarobot_models
      x-datarobot-public-preview: true
      x-datarobot-required-feature-flags:
      - *id010
  /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 list of the project's jobs.
      summary: List project jobs by project ID
      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 a job by project ID
      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 a job by project ID
      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: The list of modeling jobs.
      summary: List modeling jobs by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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: The 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 by project ID
      tags:
      - datarobot_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
            - new series optimized
            - 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: Filter models by number of clusters. Applicable only in unsupervised
          clustering projects.
        in: query
        name: numberOfClusters
        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: The number of results that are skipped.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The maximum number of models to return.
        in: query
        name: limit
        required: true
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 500
          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 by project ID
      tags:
      - datarobot_models
      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: The 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: The list of requested project modeling featurelists.
      summary: List all modeling featurelists by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      x-versionadded: v2.8
  /api/v2/projects/{projectId}/models/:
    get:
      description: "Lists all the models from a project.\n\n.. minversion:: v2.34\n\
        \    .. deprecated:: v2.34\n\n        Use :http:get:`/api/v2/projects/(projectId)/modelRecords/`\
        \ instead.\n        Fewer attributes are returned in the response of model\
        \ records route.\n\n        Removed attributes:\n\n        monotonic_increasing_featurelist_id\
        \ -- Retrievable from the blueprint level\n        monotonic_decreasing_featurelist_id\
        \ -- Retrievable from the blueprint level.\n        supports_composable_ml\
        \ -- Retrievable from the blueprint level.\n        supports_monotonic_constraints\
        \ -- Retrievable from the blueprint level.\n        has_empty_clusters --\
        \ Retrievable from the individual model level.\n        is_n_clusters_dynamically_determined\
        \ -- Retrievable from the individual model level.\n        prediction_threshold\
        \ -- Retrievable from the individual model level.\n        prediction_threshold_read_only\
        \ - Retrievable from the individual model level.\n\n        Changed attributes:\n\
        \        n_clusters becomes number_of_clusters and is returned for unsupervised\
        \ clustering models.\n"
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.0
    patch:
      description: Update a model's attributes.
      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: Update a model's attributes by project ID
      tags:
      - datarobot_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: Create advanced tuning by id
      tags:
      - datarobot_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
        by project ID
      tags:
      - datarobot_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 by project ID
      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 by project ID
      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: 0
          maximum: 12
          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 by project ID
      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 by project ID
      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: The 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: 0
          maximum: 1000
          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 by project ID
      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 by project ID
      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:
          type:
          - string
          - 'null'
      - 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 by project ID
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      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 by project ID
      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 by project ID
      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: 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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      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 by project ID
      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: The 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: 0
          maximum: 1000
          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 dataset ID 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 by project ID
      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 by project ID
      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: The confusion chart class details for the given class.
        '404':
          description: No insights found.
      summary: Calculate and sends frequency of class in distributed among other classes
        by project ID
      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: 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 by id
      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: The 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: 0
          maximum: 1000
          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 by project
        ID
      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: The 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: 0
          maximum: 1000
          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
        by project ID
      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: The 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: 0
          maximum: 1000
          type: integer
      - description: If provided, will return the residuals chart for the dataset
          with the matching dataset ID.
        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: The list of residuals chart objects by project ID
      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: The 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: 0
          maximum: 1000
          type: integer
      - description: If provided, will return the ROC curve for the dataset with the
          matching dataset ID.
        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: The 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 DEPRECATED by project ID
      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 by project ID
      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: Create fairness insights by id
      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: The model's 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 by id
      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: The 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: Create feature effects by id
      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: The project or model does not exist.
        '422':
          description: The model is datetime partitioned.
      summary: Retrieve Feature Effects metadata by project ID
      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 by project ID
      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: Create feature impact by id
      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: The 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: 0
          maximum: 1000
          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 by id
      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 by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/models/{modelId}/gridSearchScores/:
    get:
      description: Retrieve grid search scores.
      operationId: projectsModelsGridSearchScores_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: 0
          type: integer
      - description: The source for the scores. If omitted, the validation partition
          is used.
        in: query
        name: source
        required: false
        schema:
          default: validation
          enum:
          - 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/GridSearchScoresRetrieveResponse'
          description: The list of grid search scores.
        '422':
          description: Unable to process the request.
      summary: Retrieve grid search scores by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.39
  /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: The 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 by project ID
      tags:
      - insights
      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 by project ID
      tags:
      - insights
      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: The 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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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: 0
          maximum: 100
          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: 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: 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: The labelwise ROC curves for the model and given source.
      summary: Retrieve labelwise ROC curves by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      tags:
      - models
      - blueprints
      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 find missing value report for provided project and
            model ID.
      summary: Retrieve a summary of how the model's subtasks handle missing values
        by project ID
      tags:
      - datarobot_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: The model's data source.
        in: query
        name: source
        required: false
        schema:
          default: training
          enum:
          - training
          - validation
          - holdout
          type: string
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: Target class label.
        in: query
        name: class
        required: false
        schema:
          type:
          - string
          - 'null'
      - 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 multiclass feature effects by id
      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: Create multiclass feature effects by id
      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 multiclass feature impact by id
      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 multiclass lift chart by id
      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: The 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 by project ID
      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: 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: 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: The labelwise lift charts for the model and given source.
      summary: Retrieve labelwise lift charts by project ID
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project
        ID
      tags:
      - batch_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 predictions 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 by project
        ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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: 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 by project
        ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/models/{modelId}/primeInfo/:
    get:
      description: Check if a model can be approximated by DataRobot Prime.  Deprecated
        in v2.35.
      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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 {}. Deprecated in v2.35.
      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 by project ID
      tags:
      - datarobot_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 by project ID
      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: The 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 by project ID
      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 by project ID
      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 by project ID
      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: The 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 by project ID
      tags:
      - datarobot_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 the impact value, the more
        important the feature.

        DEPRECATED: Use the componentized route instead: :http:get:`/api/v2/insights/shapImpact/models/(entityId)/`'
      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 by project ID
      tags:
      - insights
      x-versionadded: v2.21
    post:
      description: 'Create SHAP-based Feature Impact for the model.

        DEPRECATED: Use the componentized route instead: :http:post:`/api/v2/insights/shapImpact/`'
      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 SHAP-based Feature Impact by project ID
      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 by project ID
      tags:
      - datarobot_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 training artifact by id by project ID
      tags:
      - models
      - blueprints
      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 by project ID
      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: The data quality log for multicategorical features.
        '422':
          description: Not a data quality enabled project.
      summary: Retrieve multicategorical data quality log by project ID
      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 by project ID
      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 by project ID
      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: The 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: 0
          maximum: 1000
          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 by project ID
      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 by project ID
      tags:
      - projects
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/optimizedDatetimePartitionings/:
    get:
      description: Lists 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: The list of optimized datetime partitionings for the project.
      summary: Lists all created optimized datetime partitioning configurations by
        project ID
      tags:
      - projects
      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: The generated datetime partitioning.
      summary: Create an optimized datetime partitioning configuration using the target
        by project ID
      tags:
      - projects
      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: The optimized datetime partitioning configuration.
      summary: Retrieve the optimized datetime partitioning configuration by project
        ID
      tags:
      - projects
      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: The optimized datetime partitioning input.
      summary: Retrieve the optimized datetime partitioning input by project ID
      tags:
      - projects
      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: The 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: 0
          maximum: 1000
          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 by project ID
      tags:
      - projects
      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 by project
        ID
      tags:
      - projects
      x-versionadded: v2.31
  /api/v2/projects/{projectId}/payoffMatrices/:
    get:
      description: List all payoff matrices for a project.
      operationId: projectsPayoffMatrices_list
      parameters:
      - description: The number of payoff matrices to skip.
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: The 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: The list of payoff matrices.
      summary: List all payoff matrices by project ID
      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 by project ID
      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: The ID 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 by project ID
      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: The ID 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: The updated payoff matrix values and label.
      summary: Update a payoff matrix by project ID
      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: The list of prediction jobs for the project.
        '404':
          description: Job was not found
      summary: List all prediction jobs by project ID
      tags:
      - batch_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 was successfully cancelled.
        '404':
          description: Job was not found or the job has already completed
      summary: Cancel a queued prediction job by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_predictions
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/predictionDatasets/:
    get:
      description: List prediction 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 prediction datasets uploaded by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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: Create URL uploads by id
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 ( by project ID
      tags:
      - batch_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 predictions in the 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 by project ID
      tags:
      - batch_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: 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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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: The number of results to skip.
        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: The dataset ID used to create the predictions.
        in: query
        name: datasetId
        required: false
        schema:
          type: string
      - description: The 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 the list of prediction records by project ID
      tags:
      - batch_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: The prediction has successfully been requested. See the 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 by project ID
      tags:
      - batch_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: 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 by project ID
      tags:
      - batch_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: The number of results to skip.
        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: The dataset ID used to create the predictions.
        in: query
        name: predictionDatasetId
        required: false
        schema:
          type: string
      - description: The 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 the list of prediction metadata records by project ID
      tags:
      - batch_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: The prediction metadata object.
        '404':
          description: Training predictions not found.
      summary: Retrieve metadata by project ID
      tags:
      - batch_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: The 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. 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 by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.4
    post:
      description: Request creation and validation of source code from a Prime model.
        Deprecated in v2.35.
      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: The prime validation job was added to queue. See the Location
            header.
          headers:
            Location:
              description: A URL that can be polled to check the status of the prime
                validation job.
              schema:
                format: url
                type: string
      summary: Create a Prime File by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 the Prime file was generated
                for.
              schema:
                type: string
      summary: Download code by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/primeModels/:
    get:
      description: List all Prime models in a project.
      operationId: projectsPrimeModels_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by project ID
      tags:
      - datarobot_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/.  Deprecated
        in v2.35.'
      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 by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.4
  /api/v2/projects/{projectId}/primeModels/{modelId}/:
    get:
      description: Retrieve 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 Prime model details by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - insights
      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 by project ID
      tags:
      - insights
      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 a rating table model by project ID
      tags:
      - insights
      x-versionadded: v2.0
  /api/v2/projects/{projectId}/ratingTables/:
    get:
      description: "List rating table 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 by project ID
      tags:
      - insights
      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 a modified rating table file by project ID
      tags:
      - insights
      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 by project ID
      tags:
      - insights
      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 by project ID
      tags:
      - insights
      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 the rating table file by project ID
      tags:
      - insights
      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 by project ID
      tags:
      - datarobot_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 the recommended model by project ID
      tags:
      - datarobot_models
      x-versionadded: v2.11
  /api/v2/projects/{projectId}/relationshipQualityAssessments/:
    post:
      description: Submit a job to assess the quality of the 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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      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 by project ID
      tags:
      - datarobot_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: The RuleFit code validation job was added to the queue. See
            the Location header.
          headers:
            Location:
              description: A URL that can be polled to check the status of the RuleFit
                code validation job.
              schema:
                format: url
                type: string
      summary: Create a RuleFit code file by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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 by project ID
      tags:
      - datarobot_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: The list of secondary dataset configurations.
        '404':
          description: Data is not found.
        '422':
          description: Unable to process the request.
      summary: List all secondary dataset configurations by project ID
      tags:
      - features
      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 by project ID
      tags:
      - features
      x-versionadded: v2.19
  /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/:
    delete:
      description: Soft-delete 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: The dataset has already been deleted.
      summary: Soft-delete a secondary dataset configuration by project ID
      tags:
      - features
      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: The secondary dataset configuration.
        '404':
          description: Data is not found.
        '422':
          description: Unable to process the request.
      summary: Retrieve secondary dataset configuration by ID by project ID
      tags:
      - features
      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 the combined model that has been updated with the
            new segment champion model.
      summary: Update champion model by project ID
      tags:
      - datarobot_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 by project ID
      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 by project ID
      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 by project ID
      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 by project ID
      tags:
      - projects
      x-versionadded: v2.27
  /api/v2/projects/{projectId}/segmentationTasks/{segmentationTaskId}/mappings/:
    get:
      description: Retrieve the series ID to segment ID 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 series ID by project ID
      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 by project ID
      tags:
      - projects
      x-versionadded: v2.28
  /api/v2/projects/{projectId}/shapMatrices/:
    get:
      description: 'Return a list of available SHAP matrix records.

        DEPRECATED: Use the componentized route instead: :http:get:`/api/v2/insights/shapMatrix/models/(entityId)/`'
      operationId: projectsShapMatrices_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 by project ID
      tags:
      - insights
      x-versionadded: v2.21
    post:
      description: 'Submit a request to calculate a matrix with SHAP based prediction
        explanations scores.

        DEPRECATED: Use the componentized route instead: :http:post:`/api/v2/insights/shapMatrix/`'
      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 the 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 by
        project ID
      tags:
      - insights
      x-versionadded: v2.21
  /api/v2/projects/{projectId}/shapMatrices/{shapMatrixId}/:
    get:
      description: 'Return matrix with SHAP-based prediction explanations scores.

        DEPRECATED: Use the componentized route instead: :http:get:`/api/v2/insights/shapMatrix/models/(entityId)/`'
      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: Return matrix with SHAP-based prediction explanations scores by project
        ID
      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 by project ID
      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: The 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: 0
          maximum: 1000
          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 by project
        ID
      tags:
      - features
      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
        by project ID
      tags:
      - features
      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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 by project ID
      tags:
      - batch_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 by project
        ID
      tags:
      - features
      x-versionadded: v2.3
  /api/v2/quotaTemplates/:
    get:
      operationId: quotaTemplates_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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaTemplateListResponse'
          description: ''
      summary: Retrieve Quota Templates
      tags:
      - quotas
      x-versionadded: v2.39
  /api/v2/quotaTemplates/{quotaTemplateId}/:
    get:
      operationId: quotaTemplates_retrieve
      parameters:
      - description: Specific quota template ID
        in: path
        name: quotaTemplateId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaTemplateResponse'
          description: ''
      summary: Retrieve Quota Templates by quota template ID
      tags:
      - quotas
      x-versionadded: v2.39
  /api/v2/quotas/:
    get:
      operationId: quotas_list
      parameters:
      - description: Resource ID for which quota is configured
        in: query
        name: resourceId
        required: false
        schema:
          type: string
      - description: Resource Type for which quota is configured
        in: query
        name: resourceType
        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
          maximum: 10000
          minimum: 1
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaListResponse'
          description: ''
      summary: Retrieve Quotas
      tags:
      - quotas
      x-versionadded: v2.39
    post:
      operationId: quotas_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuotaCreate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaResponse'
          description: ''
      summary: Create Quotas
      tags:
      - quotas
      x-versionadded: v2.43
  /api/v2/quotas/{quotaId}/:
    delete:
      operationId: quotas_delete
      parameters:
      - description: Specific quota ID
        in: path
        name: quotaId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
        '204':
          description: The quota has been deleted.
      summary: Delete Quotas by quota ID
      tags:
      - quotas
      x-versionadded: v2.39
    get:
      operationId: quotas_retrieve
      parameters:
      - description: Specific quota ID
        in: path
        name: quotaId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaResponse'
          description: ''
      summary: Retrieve Quotas by quota ID
      tags:
      - quotas
      x-versionadded: v2.39
    patch:
      operationId: quotas_patch
      parameters:
      - description: Specific quota ID
        in: path
        name: quotaId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuotaUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaResponse'
          description: ''
      summary: Modify Quotas by quota ID
      tags:
      - quotas
      x-versionadded: v2.39
  /api/v2/recipes/:
    get:
      description: Get a list of the recipes available for given user.
      operationId: recipes_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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
            - postgres
            type: string
          - items:
              enum:
              - snowflake
              - bigquery
              - spark-feature-discovery
              - databricks
              - spark
              - postgres
              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:
            - sql
            - Sql
            - SQL
            - wrangling
            - Wrangling
            - WRANGLING
            - featureDiscovery
            - FeatureDiscovery
            - FEATURE_DISCOVERY
            - featureDiscoveryPrivatePreview
            - FeatureDiscoveryPrivatePreview
            - FEATURE_DISCOVERY_PRIVATE_PREVIEW
            type: string
          - items:
              enum:
              - sql
              - Sql
              - SQL
              - 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-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
      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 by recipe ID
      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 by recipe ID
      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 by recipe ID
      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 by recipe ID
      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 by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.33
    put:
      description: Set the inputs on a recipe to change the configuration. Implicitly
        restart the initial sampling job which calculates:1) Column names;2) resulting
        size of the sample in bytes;3) resulting size of the sample in rows.
      operationId: recipesInputs_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/RecipeInputUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: ''
      summary: Sets the input of the given recipe by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.35
  /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 number indicating how many operations from the beginning
          to return insights for.
        in: query
        name: numberOfOperationsToUse
        required: false
        schema:
          minimum: 0
          type: integer
        x-versionadded: v2.35
      - 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 by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/operations/:
    put:
      description: Updates the operations in a recipe by saving new directives. To
        validate the new operations, run preview validation and SQL generation. To
        apply them to the new recipe, you must run a request to preview the results
        must be run.
      operationId: recipesOperations_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/RecipeOperationsUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeResponse'
          description: ''
        '409':
          description: Operations can't be applied due to a wrangling session state.
        '422':
          description: Cannot modify published recipe.
      summary: Update the operations by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.35
  /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 by recipe ID
      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: The 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: 0
          maximum: 1000
          type: integer
      - description: The number indicating how many operations from the beginning
          to retrieve a preview for.
        in: query
        name: numberOfOperationsToUse
        required: false
        schema:
          minimum: 0
          type: integer
        x-versionadded: v2.35
      - 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 by recipe ID
      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/RecipeRunPreviewAsync'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: ''
        '422':
          description: Credentials were not provided and default credentials were
            not found.
      summary: Start the job by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/relationshipQualityAssessments/:
    post:
      description: Submit a job to assess the quality of the relationship configuration
        within a Feature Discovery session in Workbench.
      operationId: recipesRelationshipQualityAssessments_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/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 by recipe ID
      tags:
      - data_wrangling
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables support of late project creation in Feature Discovery
          to separate feature selection from the Feature Discovery editor.
        enabled_by_default: true
        maturity: GA_ALL
        name: FEATURE_DISCOVERY_LATE_PROJECT_CREATION
      - description: Allows users to perform Feature Discovery on datasets in Workbench.
        enabled_by_default: true
        maturity: GA_ALL
        name: UXR_FEATURE_DISCOVERY
      x-versionadded: v2.35
  /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 by recipe ID
      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 by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.33
  /api/v2/recipes/{recipeId}/timeseriesTransformationPlans/:
    post:
      description: Generate a list of recipe operations, which serve as the plan to
        transform a regular dataset into a time series dataset.
      operationId: recipesTimeseriesTransformationPlans_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/GenerateTransformationPlan'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: ''
      summary: Generate a time series transformation plan by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.36
  /api/v2/recipes/{recipeId}/timeseriesTransformationPlans/{id}/:
    get:
      description: Returns a list of recipe operations, which serve as the plan to
        transform a regular dataset into a time series dataset.
      operationId: recipesTimeseriesTransformationPlans_retrieve
      parameters:
      - description: The ID of the recipe.
        in: path
        name: recipeId
        required: true
        schema:
          type: string
      - description: The ID of the transformation plan.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransformationPlanResponse'
          description: ''
      summary: Retrieve generated time series transformation plan by recipe ID
      tags:
      - data_wrangling
      x-versionadded: v2.36
  /api/v2/recommendedSettings/{entityType}/:
    get:
      description: Retrieve configured recommended settings for an entity.
      operationId: recommendedSettings_retrieve
      parameters:
      - description: The type of the entity to create or get the recommended settings
          for.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedSettingsResponse'
          description: ''
      summary: Retrieve configured recommended settings by entitytype
      tags:
      - approval_workflows
      x-versionadded: v2.38
    put:
      description: Update recommended settings for an entity.
      operationId: recommendedSettings_put
      parameters:
      - description: The type of the entity to create or get the recommended settings
          for.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecommendedSettingsUpdate'
      responses:
        '200':
          description: ''
      summary: Update recommended settings by entitytype
      tags:
      - approval_workflows
      x-versionadded: v2.38
  /api/v2/recommendedSettings/{entityType}/choices/:
    get:
      description: Retrieve the list of available setting choices for an entity.
      operationId: recommendedSettingsChoices_list
      parameters:
      - description: The type of the entity to create or get the recommended settings
          for.
        in: path
        name: entityType
        required: true
        schema:
          enum:
          - deployment
          - Deployment
          - DEPLOYMENT
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendedSettingsChoices'
          description: ''
      summary: Retrieve the list of available setting choices by entitytype
      tags:
      - approval_workflows
      x-versionadded: v2.38
  /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: 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: The name of the target used for filtering.
        in: query
        name: targetName
        required: false
        schema:
          type: string
      - description: The type of target(s) to filter by.
        in: query
        name: targetType
        required: false
        schema:
          oneOf:
          - description: The target type used for filtering.
            type: string
          - description: A list of target types to filter by.
            items:
              description: Type of the target to filter by
              type: string
            maxItems: 10
            type: array
      - description: Email of the user that created registered model to filter by
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: The key to order results 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. If multiple tag keys are provided,
          registered models matching any of the tag keys are returned.
        in: query
        name: tagKeys
        required: false
        schema:
          type: string
      - description: List of tag values to filter by. If multiple tag values are provided,
          registered models matching any of the tag values are returned.
        in: query
        name: tagValues
        required: false
        schema:
          type: string
      - description: Comma separated tag pairs (e.g., key1%3Dvalue2,key2%3Dvalue2).
          Only registered models that match exactly (case sensitive) are returned.If
          specified, this overrides the tagKey and tagValues query params.If multiple
          tag filters (up to 10) are provided, registered models matching any of the
          tag filters are selected. These registered models will be further filtered
          by other query params such as targetType.
        in: query
        name: tagFilters
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisteredModelListResponse'
          description: ''
      summary: List registered models.
      tags:
      - model_management
      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: The ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Archive a registered model by registered model ID
      tags:
      - model_management
      x-versionadded: v2.32
    get:
      description: Retrieve information about a registered model.
      operationId: registeredModels_retrieve
      parameters:
      - description: The 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 information about a registered model by registered model ID
      tags:
      - model_management
      x-versionadded: v2.32
    patch:
      description: Update a registered model.
      operationId: registeredModels_patch
      parameters:
      - description: The 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 a registered model by registered model ID
      tags:
      - model_management
      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: 0
          type: integer
      - description: Filter deployments with name matching search term
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: The key to order results 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: The 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 by registered model ID
      tags:
      - model_management
      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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The 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 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 the registered model access control list by registered model ID
      tags:
      - model_management
      x-versionadded: v2.32
    patch:
      description: Set roles for users on this registered model.
      operationId: registeredModelsSharedRoles_patchMany
      parameters:
      - description: The 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: The roles were 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 the registered model controls by registered model ID
      tags:
      - model_management
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/versions/:
    get:
      description: List the 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: 0
          type: integer
      - description: The key to order results 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: The 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 the registered model's versions by registered model ID
      tags:
      - model_management
      x-versionadded: v2.32
  /api/v2/registeredModels/{registeredModelId}/versions/{versionId}/:
    get:
      description: Get the registered model's version.
      operationId: registeredModelsVersions_retrieve
      parameters:
      - description: The ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      - description: The 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 the registered model's version by registered model ID
      tags:
      - model_management
      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: 0
          type: integer
      - description: Filter deployments with name matching search term
        in: query
        name: search
        required: false
        schema:
          maxLength: 512
          type: string
      - description: The key to order results 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: The ID of the registered model.
        in: path
        name: registeredModelId
        required: true
        schema:
          type: string
      - description: The 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 by registered model ID
      tags:
      - model_management
      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:
      - features
      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 by relationships configuration
        ID
      tags:
      - features
      x-versionadded: v2.21
    get:
      description: Retrieve a relationships configuration
      operationId: relationshipsConfigurations_retrieve
      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: 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/ExtendedRelationshipsConfigRetrieve'
          description: ''
        '404':
          description: Relationships configuration cannot be found
      summary: Retrieve a relationships configuration by relationships configuration
        ID
      tags:
      - features
      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 by relationships configuration
        ID
      tags:
      - features
      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 by relationships configuration
        ID
      tags:
      - features
      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/runtimeParameters/reservedNames/:
    get:
      description: Retrieve the list of reserved environment variable name patterns
        that cannot be used as runtime parameter names. Supports wildcard patterns
        (* and ?) and entity-specific restrictions.
      operationId: runtimeParametersReservedNames_list
      parameters:
      - description: 'The entity type to get reserved names for. Valid values: customModel,
          customApplication, customJob'
        in: query
        name: entityType
        required: true
        schema:
          enum:
          - customModel
          - customApplication
          - customJob
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeParameterReservedNamesResponse'
          description: The reserved runtime parameter names.
        '400':
          description: Invalid entity type provided.
      summary: Retrieve reserved runtime parameter names.
      tags:
      - custom_models
      x-datarobot-public-preview: false
      x-datarobot-required-feature-flags:
      - description: Enables the addition of key-value pairs as Runtime-Parameters
          for Custom Inference Models.
        enabled_by_default: true
        maturity: GA_ALL
        name: CUSTOM_MODEL_RUNTIME_PARAMETERS
      x-versionadded: v2.44
  /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:
      - batch_predictions
      x-versionadded: v2.21
  /api/v2/seatLicenseAllocations/:
    get:
      description: List seat license allocations. Org admins can view seat licenses
        that were allocated to their organization. System admins can view allocations
        across all organizations.
      operationId: seatLicenseAllocations_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: List seat license allocations by the specified IDs.
        in: query
        name: ids
        required: false
        schema:
          oneOf:
          - maxLength: 36
            minLength: 32
            type: string
          - items:
              maxLength: 36
              minLength: 32
              type: string
            maxItems: 100
            type: array
      - description: The ID of the organization the seat licenses have been allocated
          to.
        in: query
        name: orgId
        required: false
        schema:
          type: string
      - description: List seat license allocations by the seat license IDs.
        in: query
        name: seatLicenseIds
        required: false
        schema:
          oneOf:
          - maxLength: 36
            minLength: 32
            type: string
          - items:
              maxLength: 36
              minLength: 32
              type: string
            maxItems: 100
            type: array
      - description: The subject IDs that should be part of the seat license allocations
        in: query
        name: subjectIds
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeatLicenseAllocationsListResponse'
          description: The listed seat license allocations.
      summary: List seat license allocations.
      tags:
      - seat_licenses
      x-versionadded: v2.36
    post:
      description: Allocate the seat license to the organization, given that the total
        number of allocated seats in the cluster, including the new organization's
        limit, does not exceed the cluster-level limit applied through the license
        key. Available to system admins only.
      operationId: seatLicenseAllocations_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SeatLicenseAllocationCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeatLicenseAllocation'
          description: The allocated seat license for the organization.
      summary: Allocate seat licenses.
      tags:
      - seat_licenses
      x-versionadded: v2.36
  /api/v2/seatLicenseAllocations/evaluate/:
    post:
      description: Evaluate whether the subject has been authorized to use the seat
        license.
      operationId: seatLicenseAllocationsEvaluate_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SeatLicenseEvaluateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeatLicenseEvaluateResponse'
          description: The evaluation was performed successfully.
      summary: Evaluate the seat license
      tags:
      - seat_licenses
      x-versionadded: v2.36
  /api/v2/seatLicenseAllocations/{allocationId}/:
    delete:
      description: Delete the seat license allocation. Only system admins can execute
        this operation.
      operationId: seatLicenseAllocations_delete
      parameters:
      - description: The ID of the seat license allocation.
        in: path
        name: allocationId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '204':
          description: The seat license allocation was successfully deleted.
      summary: Delete a seat license allocation by allocation ID
      tags:
      - seat_licenses
      x-versionadded: v2.36
    get:
      description: Retrieve an allocated seat license by ID. Org admins can view seat
        licenses that were allocated to their organization. System admins can view
        allocations across all organizations.
      operationId: seatLicenseAllocations_retrieve
      parameters:
      - description: The ID of the seat license allocation.
        in: path
        name: allocationId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeatLicenseAllocation'
          description: The seat license allocation was successfully retrieved.
      summary: Retrieve a seat license allocation by allocation ID
      tags:
      - seat_licenses
      x-versionadded: v2.36
    patch:
      description: Update Seat License Allocation.
      operationId: seatLicenseAllocations_patch
      parameters:
      - description: The ID of the seat license allocation.
        in: path
        name: allocationId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SeatLicenseAllocationUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeatLicenseAllocation'
          description: The updated seat license allocation for the organization.
      summary: Update a seat license allocation by allocation ID
      tags:
      - seat_licenses
      x-versionadded: v2.36
  /api/v2/seatLicenses/:
    get:
      description: List seat licenses in the current installation. Seat licenses may
        become available only when applied through the cluster license. Accessible
        to system admins only.
      operationId: seatLicenses_list
      parameters:
      - description: List seat licenses by the specified IDs.
        in: query
        name: ids
        required: false
        schema:
          oneOf:
          - maxLength: 36
            minLength: 32
            type: string
          - items:
              maxLength: 36
              minLength: 32
              type: string
            maxItems: 100
            type: array
      - description: List seat licenses by the specified names.
        in: query
        name: names
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 100
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SeatLicensesListResponse'
          description: The listed seat licenses.
      summary: List seat licenses.
      tags:
      - seat_licenses
      x-versionadded: v2.36
  /api/v2/secureConfigSchemas/:
    get:
      description: Retrieve all secure configuration schemas.
      operationId: secureConfigSchemas_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: 0
          type: integer
      - description: The order to sort the secure configuration schemas. Defaults
          to the order by the name in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          default: name
          enum:
          - name
          - -name
          type: string
      - description: Filter for a specific secure configuration schema name.
        in: query
        name: name
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigSchemaListResponse'
          description: The list of secure configuration schemas.
      summary: Retrieve a list of secure configuration schemas.
      tags:
      - secure_config
      x-versionadded: v2.36
  /api/v2/secureConfigSchemas/{secureConfigSchemaId}/:
    get:
      description: Retrieve a secure configuration schema.
      operationId: secureConfigSchemas_retrieve
      parameters:
      - description: The ID of the secure configuration schema.
        in: path
        name: secureConfigSchemaId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigSchema'
          description: The configuration schema.
      summary: Retrieve a secure configuration schema by secure config schema ID
      tags:
      - secure_config
      x-versionadded: v2.36
  /api/v2/secureConfigs/:
    get:
      description: Retrieve all secure configurations.
      operationId: secureConfigs_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: 0
          type: integer
      - description: The order to sort the secure configurations. Defaults to the
          order by the name in descending order.
        in: query
        name: orderBy
        required: false
        schema:
          default: name
          enum:
          - name
          - -name
          - createdAt
          - -createdAt
          type: string
      - description: Filter for a specific secure configuration name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Filter for a secure configuration name.
        in: query
        name: namePart
        required: false
        schema:
          type: string
      - description: A comma-separated list of schema names to filter on.
        in: query
        name: schemas
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigListResponse'
          description: The list of secure configurations.
      summary: Retrieve a list of secure configurations.
      tags:
      - secure_config
      x-versionadded: v2.36
    post:
      description: Create a secure configuration.
      operationId: secureConfigs_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecureConfigCreate'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigResponse'
          description: The created secure configuration.
      summary: Create a secure configuration.
      tags:
      - secure_config
      x-versionadded: v2.36
  /api/v2/secureConfigs/{secureConfigId}/:
    delete:
      description: Delete secure configuration and its values.
      operationId: secureConfigs_delete
      parameters:
      - description: The ID of the secure configuration.
        in: path
        name: secureConfigId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '204':
          description: Secure configuration deleted successfully.
      summary: Delete secure configuration by secure config ID
      tags:
      - secure_config
      x-versionadded: v2.36
    get:
      description: Retrieve a secure configuration.
      operationId: secureConfigs_retrieve
      parameters:
      - description: The ID of the secure configuration.
        in: path
        name: secureConfigId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigResponse'
          description: The secure configuration.
      summary: Retrieve a secure configuration by secure config ID
      tags:
      - secure_config
      x-versionadded: v2.36
    patch:
      description: Update a secure configuration.
      operationId: secureConfigs_patch
      parameters:
      - description: The ID of the secure configuration.
        in: path
        name: secureConfigId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecureConfigUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigResponse'
          description: The updated secure configuration.
      summary: Update a secure configuration by secure config ID
      tags:
      - secure_config
      x-versionadded: v2.36
  /api/v2/secureConfigs/{secureConfigId}/sharedRoles/:
    get:
      description: Get a list of users, groups, and organizations that have access
        to this secure configuration.
      operationId: secureConfigsSharedRoles_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: 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: 'The recipient type: one of ''user'', ''group'', or ''organization''.'
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The ID of the secure configuration.
        in: path
        name: secureConfigId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigSharedRolesList'
          description: ''
      summary: Get a list of users, groups, and organizations that have access by
        secure config ID
      tags:
      - secure_config
      x-versionadded: v2.36
    patch:
      description: Share a secure configuration with a user, group or organization.
      operationId: secureConfigsSharedRoles_patchMany
      parameters:
      - description: The ID of the secure configuration.
        in: path
        name: secureConfigId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecureConfigSharingUpdate'
      responses:
        '204':
          description: The roles were updated successfully.
        '422':
          description: The request was formatted improperly.
      summary: Share a secure configuration by secure config ID
      tags:
      - secure_config
      x-versionadded: v2.36
  /api/v2/secureConfigs/{secureConfigId}/values/:
    get:
      description: Retrieve all values created for the secure configuration.
      operationId: secureConfigsValues_list
      parameters:
      - description: Consumer access to the Secure Config values.
        in: query
        name: consumer
        required: false
        schema:
          default: false
          type: boolean
      - description: The ID of the secure configuration.
        in: path
        name: secureConfigId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureConfigListValuesResponse'
          description: A list of values for the secure configuration.
      summary: Retrieve a list of values by secure config ID
      tags:
      - secure_config
      x-versionadded: v2.36
  /api/v2/sparkSessions/:
    delete:
      description: Stop the underlying interactive Spark session, if applicable.
      operationId: sparkSessions_deleteMany
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopSession'
      responses:
        '204':
          description: ''
      summary: Stop wrangling session.
      tags:
      - data_wrangling
      x-versionadded: v2.38
  /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: 0
          maximum: 1000
          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
      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 by configuration
        ID
      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:
        '204':
          description: ''
      summary: Update an SSO configuration by configuration ID
      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 by status ID
      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 by status ID
      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: The encrypted string.
      summary: Encrypt a string
      tags:
      - utilities
      x-versionadded: v2.4
  /api/v2/tenantUsageResources/:
    get:
      description: A unified route to retrieve aggregated resource usage over some
        period of time. For OrgAdmins, tenant_id is required. For SystemAdmins, tenant_id
        is optional. If tenant_id is omitted for SystemAdmins, returns usage for all
        tenants.
      operationId: tenantUsageResources_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      - description: The ID of the tenant. Optional for System Admins, required for
          Org Admins.
        in: query
        name: tenantId
        required: false
        schema:
          maxLength: 36
          minLength: 32
          type: string
      - description: Only usage performed by this user will be retrieved.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The workload category.
        in: query
        name: workloadCategory
        required: false
        schema:
          default: all
          enum:
          - all
          - All
          - ALL
          - gpuUsage
          - GpuUsage
          - GPU_USAGE
          - llmUsage
          - LlmUsage
          - LLM_USAGE
          - cpuUsage
          - CpuUsage
          - CPU_USAGE
          - storage
          - Storage
          - STORAGE
          - agenticMonitoringSpans
          - AgenticMonitoringSpans
          - AGENTIC_MONITORING_SPANS
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
          description: ''
      summary: Get usage resources
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenantUsageResources/activeTenants/:
    get:
      description: A route to retrieve active tenants over a specified time period.
        Only admins can perform this operation.
      operationId: tenantUsageResourcesActiveTenants_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveTenantsResponse'
          description: ''
      summary: Get active tenants
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenantUsageResources/activeUsers/:
    get:
      description: 'A unified route to retrieve active users over a specified time
        period. For OrgAdmins, tenant_id is required. For SystemAdmins, tenant_id
        is optional. If tenant_id is omitted for SystemAdmins with feature flag, returns
        all users in the cluster. If tenant_id is provided, returns only users in
        that tenant. '
      operationId: tenantUsageResourcesActiveUsers_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      - description: The ID of the tenant. Optional for System Admins, required for
          Org Admins.
        in: query
        name: tenantId
        required: false
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveUsersResponse'
          description: ''
      summary: Get active users
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenantUsageResources/categories/:
    get:
      description: A route to retrieve available resource categories for tenant usage.
      operationId: tenantUsageResourcesCategories_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCategoriesResponse'
          description: ''
      summary: Get the available resource categories.
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenantUsageResources/export/:
    get:
      description: A unified route to export resource usage over a specified time
        period. For OrgAdmins, tenant_id is required. For SystemAdmins, tenant_id
        is optional. If tenant_id is omitted for SystemAdmins, returns usage for all
        tenants. If tenant_id is provided, returns usage only for that tenant. If
        user_id is provided, returns usage only for that user.
      operationId: tenantUsageResourcesExport_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      - description: Only usage performed by this user will be retrieved.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The workload category.
        in: query
        name: workloadCategory
        required: false
        schema:
          default: all
          enum:
          - all
          - All
          - ALL
          - gpuUsage
          - GpuUsage
          - GPU_USAGE
          - llmUsage
          - LlmUsage
          - LLM_USAGE
          - cpuUsage
          - CpuUsage
          - CPU_USAGE
          - storage
          - Storage
          - STORAGE
          - agenticMonitoringSpans
          - AgenticMonitoringSpans
          - AGENTIC_MONITORING_SPANS
          type: string
      - description: The ID of the tenant. Optional for System Admins, required for
          Org Admins.
        in: query
        name: tenantId
        required: false
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResponse'
          description: ''
      summary: Export usage
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenants/utilizationResources/:
    get:
      description: A route to retrieve aggregated CPU/GPU resources utilization for
        certain resource type.
      operationId: tenantsUtilizationResources_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResourceTypeResponse'
          description: ''
      summary: Get CPU/GPU resource utilization.
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenants/utilizationResources/export/:
    get:
      description: A route to retrieve aggregated CPU and GPU resources utilization.
      operationId: tenantsUtilizationResourcesExport_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The resolution for the usage data.
        in: query
        name: resolution
        required: false
        schema:
          type: string
      - description: The filename for the usage data.
        in: query
        name: filename
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResourceUtilizationResponse'
          description: ''
      summary: Export CPU/GPU resource utilization.
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenants/utilizationResources/{resourceType}/:
    get:
      description: A route to retrieve aggregated CPU/GPU resources utilization for
        certain resource type.
      operationId: tenantsUtilizationResources_retrieve
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: false
        schema:
          format: date-time
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: false
        schema:
          format: date-time
          type: string
      - description: The resolution for the usage data.
        in: query
        name: resolution
        required: false
        schema:
          type: string
      - description: 'Resource type: CPU/GPU.'
        in: path
        name: resourceType
        required: true
        schema:
          enum:
          - gpu
          - Gpu
          - GPU
          - cpu
          - Cpu
          - CPU
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResourceUtilizationResponse'
          description: ''
      summary: Get CPU/GPU resource utilization by resourcetype
      tags:
      - user_management
      x-versionadded: v2.39
  /api/v2/tenants/{tenantId}/activeUsers/:
    get:
      description: 'DEPRECATED: This endpoint is deprecated. Use /activeUsers/ instead.
        A route to retrieve active tenant users over a specified time period. Only
        system or organization admins can perform this operation.'
      operationId: tenantsActiveUsers_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      - description: The ID of the tenant.
        in: path
        name: tenantId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveUsersResponse'
          description: ''
      summary: Get tenant active users by tenant ID
      tags:
      - user_management
      x-versionadded: v2.35
  /api/v2/tenants/{tenantId}/resourceCategories/:
    get:
      description: A route to retrieve available resource categories for tenant usage.
      operationId: tenantsResourceCategories_list
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCategoriesResponse'
          description: ''
      summary: Get the available resource categories by tenant ID
      tags:
      - user_management
      x-versionadded: v2.37
  /api/v2/tenants/{tenantId}/usage/:
    get:
      description: 'DEPRECATED: This endpoint is deprecated. Use `/tenantUsageResources/`
        instead. A route to retrieve aggregated or per-user tenant resource usage
        over some period of time. Only system or organization admins can perform this
        operation.'
      operationId: tenantsUsage_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      - description: Only usage performed by this user will be retrieved.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The workload category.
        in: query
        name: workloadCategory
        required: false
        schema:
          default: all
          enum:
          - all
          - All
          - ALL
          - gpuUsage
          - GpuUsage
          - GPU_USAGE
          - llmUsage
          - LlmUsage
          - LLM_USAGE
          - cpuUsage
          - CpuUsage
          - CPU_USAGE
          - storage
          - Storage
          - STORAGE
          - agenticMonitoringSpans
          - AgenticMonitoringSpans
          - AGENTIC_MONITORING_SPANS
          type: string
      - description: The ID of the tenant.
        in: path
        name: tenantId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
          description: ''
      summary: Get tenant usage by tenant ID
      tags:
      - user_management
      x-versionadded: v2.35
  /api/v2/tenants/{tenantId}/usageExport/:
    get:
      description: 'DEPRECATED: This endpoint is deprecated. Use /usageExport/ instead.
        A route to retrieve tenant resource usage over a specified time period. Only
        system or organization admins can perform this operation.'
      operationId: tenantsUsageExport_list
      parameters:
      - description: The start date for the usage data.
        in: query
        name: start
        required: true
        schema:
          format: date
          type: string
      - description: The end date for the usage data.
        in: query
        name: end
        required: true
        schema:
          format: date
          type: string
      - description: Only usage performed by this user will be retrieved.
        in: query
        name: userId
        required: false
        schema:
          type: string
      - description: The workload category.
        in: query
        name: workloadCategory
        required: false
        schema:
          default: all
          enum:
          - all
          - All
          - ALL
          - gpuUsage
          - GpuUsage
          - GPU_USAGE
          - llmUsage
          - LlmUsage
          - LLM_USAGE
          - cpuUsage
          - CpuUsage
          - CPU_USAGE
          - storage
          - Storage
          - STORAGE
          - agenticMonitoringSpans
          - AgenticMonitoringSpans
          - AGENTIC_MONITORING_SPANS
          type: string
      - description: The ID of the tenant.
        in: path
        name: tenantId
        required: true
        schema:
          maxLength: 36
          minLength: 32
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResponse'
          description: ''
      summary: Export tenant usage by tenant ID
      tags:
      - user_management
      x-versionadded: v2.35
  /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. The async
        task status should be polled in order to retrieve the artifact ID.
      operationId: usageDataExports_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UsageDataExport'
      responses:
        '202':
          description: Customer usage data artifact creation started. The status can
            be tracked at the Location field in the headers.
        '400':
          description: Artifact creation process encountered a problem.
      summary: Create a customer usage data artifact request
      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: The list of supported available audit events.
      summary: 'Describe supported available audit events with '
      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 by artifact ID
      tags:
      - analytics
      x-versionadded: v2.11
  /api/v2/useCases/:
    get:
      description: Retrieve the 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: 0
          maximum: 100
          type: integer
      - description: Returns only Use Cases with names that match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Only return experiment containers associated with the given project
          ID.
        in: query
        name: projectId
        required: false
        schema:
          type: string
        x-versiondeprecated: v2.35
      - description: Only return experiment containers associated with the given app.
        in: query
        name: applicationId
        required: false
        schema:
          type: string
        x-versiondeprecated: v2.35
      - description: The id of the entity type that is linked with the Use Case.
        in: query
        name: entityId
        required: false
        schema:
          type: string
      - description: The entity type that is linked to the use case.
        in: query
        name: entityType
        required: false
        schema:
          enum:
          - project
          - dataset
          - file
          - notebook
          - application
          - recipe
          - playground
          - vectorDatabase
          - syftrSearchInstance
          - embeddingModelValidation
          - customModelVersion
          - registeredModelVersion
          - deployment
          - customApplication
          - customJob
          type: string
      - description: '[DEPRECATED - replaced with order_by] The order in which Use
          Cases and return Use Cases.'
        in: query
        name: sort
        required: true
        schema:
          default: id
          enum:
          - -applicationsCount
          - -createdAt
          - -createdBy
          - -customApplicationsCount
          - -datasetsCount
          - -description
          - -filesCount
          - -id
          - -name
          - -notebooksCount
          - -playgroundsCount
          - -potentialValue
          - -projectsCount
          - -riskLevel
          - -stage
          - -updatedAt
          - -updatedBy
          - -vectorDatabasesCount
          - applicationsCount
          - createdAt
          - createdBy
          - customApplicationsCount
          - datasetsCount
          - description
          - filesCount
          - id
          - name
          - notebooksCount
          - playgroundsCount
          - potentialValue
          - projectsCount
          - riskLevel
          - stage
          - updatedAt
          - updatedBy
          - vectorDatabasesCount
          type: string
        x-versiondeprecated: v2.32
      - description: The order in which use cases are returned.
        in: query
        name: orderBy
        required: true
        schema:
          default: id
          enum:
          - -applicationsCount
          - -createdAt
          - -createdBy
          - -customApplicationsCount
          - -datasetsCount
          - -description
          - -filesCount
          - -id
          - -name
          - -notebooksCount
          - -playgroundsCount
          - -potentialValue
          - -projectsCount
          - -riskLevel
          - -stage
          - -updatedAt
          - -updatedBy
          - -vectorDatabasesCount
          - applicationsCount
          - createdAt
          - createdBy
          - customApplicationsCount
          - datasetsCount
          - description
          - filesCount
          - id
          - name
          - notebooksCount
          - playgroundsCount
          - potentialValue
          - projectsCount
          - riskLevel
          - stage
          - updatedAt
          - updatedBy
          - vectorDatabasesCount
          type: string
      - description: A filter to return use cases by type.
        in: query
        name: usecaseType
        required: true
        schema:
          default: all
          enum:
          - all
          - general
          - walkthrough
          type: string
      - description: Only return Use Cases associated with the given risk level.
        in: query
        name: riskLevel
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
      - description: Only return use cases in the given stage.
        in: query
        name: stage
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 7
            type: array
      - description: Filter Use Cases to return only those created by the selected
          user.
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: Defines if the Use Cases available on Organization level should
          be shown.
        in: query
        name: showOrgUseCases
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseListResponse'
          description: The use cases were retrieved successfully.
        '403':
          description: User does not have access to this functionality.
      summary: Retrieve the 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: The 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: 0
          maximum: 100
          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: 0
          maximum: 365
          type: integer
      - description: The 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
            maxItems: 3
            minItems: 1
            type: array
        x-versionadded: v2.33
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseRecentAssetsListResponse'
          description: ''
      summary: Get the list of the references associated
      tags:
      - use_cases
      x-versionadded: v2.33
  /api/v2/useCases/notebooks/:
    get:
      description: Get the list of the notebooks from all use cases.
      operationId: use_cases_all_notebooks
      parameters:
      - description: The 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: 0
          maximum: 100
          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 the list of the notebooks
      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 by use case ID
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseResponse'
          description: ''
      summary: Get a use case by use case ID
      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: The use case was not found.
        '422':
          description: Unprocessable Entity
      summary: Update a Use Case by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/applications/:
    get:
      description: Get the list of the applications associated with a Use Case.
      operationId: useCasesApplications_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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 the list of the applications associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/customApplications/:
    get:
      description: The list of the custom applications referenced by a use case.
      operationId: useCasesCustomApplications_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: 10
          exclusiveMinimum: 0
          maximum: 100
          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/UseCaseCustomApplicationsResponse'
          description: ''
      summary: The list of the custom applications referenced by a use case by use
        case ID
      tags:
      - use_cases
      x-versionadded: v2.35
  /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: The 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: 0
          maximum: 100
          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
            - sqlRecipe
            - SqlRecipe
            - SQL_RECIPE
            - 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
              - sqlRecipe
              - SqlRecipe
              - SQL_RECIPE
              - 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: The 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 by use case ID
      tags:
      - use_cases
      x-versionadded: v2.33
  /api/v2/useCases/{useCaseId}/datasets/:
    get:
      description: Get the list of the datasets associated with a use case.
      operationId: useCasesDatasets_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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 the list of the datasets associated by use case ID
      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 the dataset details by use case ID
      tags:
      - use_cases
      x-versionadded: v2.33
  /api/v2/useCases/{useCaseId}/deployments/:
    get:
      description: The list of deployments associated with the use case.
      operationId: useCasesDeployments_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: The order to sort the use case deployments.
        in: query
        name: orderBy
        required: true
        schema:
          default: -updatedAt
          enum:
          - -createdAt
          - -createdBy
          - -lastActivity
          - -name
          - -updatedAt
          - -updatedBy
          - createdAt
          - createdBy
          - lastActivity
          - name
          - updatedAt
          - updatedBy
          type: string
      - description: Only return deployments from the 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.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentPagination'
          description: The list of deployments.
      summary: Get the deployments associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.35
  /api/v2/useCases/{useCaseId}/files/:
    get:
      description: Get the list of the catalog files associated with a use case.
      operationId: useCasesFiles_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: The order to sort the Use Case files.
        in: query
        name: orderBy
        required: true
        schema:
          default: -modifiedAt
          enum:
          - -createdAt
          - -createdBy
          - -dataSourceType
          - -fileSourceType
          - -lastActivity
          - -modifiedAt
          - -modifiedBy
          - -name
          - -numFiles
          - createdAt
          - createdBy
          - dataSourceType
          - fileSourceType
          - lastActivity
          - modifiedAt
          - modifiedBy
          - name
          - numFiles
          type: string
      - description: Only return files from Use Cases 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/UseCaseFilesListResponse'
          description: ''
        '403':
          description: User does not have access to this functionality.
      summary: Get the list of the catalog files associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.37
  /api/v2/useCases/{useCaseId}/files/{fileId}/:
    get:
      description: Retrieves the details of the file with given ID for a given Use
        Case ID.
      operationId: useCasesFiles_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 file.
        in: path
        name: fileId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullFileDetailsResponse'
          description: The file details.
      summary: Get the file details by use case ID
      tags:
      - use_cases
      x-versionadded: v2.37
  /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 by use
        case ID
      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: The 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: 0
          maximum: 100
          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: The 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
          - F1 Score
          - Weighted F1 Score
          - Precision
          - Weighted Precision
          - Recall
          - Weighted Recall
          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: The 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: 0
            maximum: 100
            type: number
          - items:
              exclusiveMinimum: 0
              maximum: 100
              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 by use
        case ID
      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 by use case ID
      tags:
      - use_cases
      x-versionadded: v2.35
  /api/v2/useCases/{useCaseId}/notebooks/:
    get:
      description: Get the list of the notebooks associated with a use case.
      operationId: useCasesNotebooks_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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 the list of the notebooks associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/playgrounds/:
    get:
      description: Get the list of the playgrounds associated with a Use Case.
      operationId: useCasesPlaygrounds_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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 the list of the playgrounds associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/projects/:
    get:
      description: Get the list of the projects associated with a use case.
      operationId: useCasesProjects_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: Returns only 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 the list of the projects associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/registeredModels/:
    get:
      description: The list of the registered models referenced by a use case.
      operationId: useCasesRegisteredModels_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
          10.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          exclusiveMinimum: 0
          maximum: 100
          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/UseCaseRegisteredModelsResponse'
          description: ''
      summary: The list of the registered models referenced by a use case by use case
        ID
      tags:
      - use_cases
      x-versionadded: v2.35
  /api/v2/useCases/{useCaseId}/resources/:
    get:
      description: Get the list of the references associated with a use case.
      operationId: useCasesResources_list
      parameters:
      - description: The 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: 0
          maximum: 100
          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: 0
          maximum: 365
          type: integer
      - description: The 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
            maxItems: 3
            minItems: 1
            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 the list of the references associated by use case ID
      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 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: 0
          maximum: 100
          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 the use case's access control list by use case ID
      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/UseCaseSharedRolesUpdate'
      responses:
        '200':
          description: ''
      summary: Update the Use Case's access control list by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/vectorDatabases/:
    get:
      description: Get a list of vector databases associated with a Use Case.
      operationId: useCasesVectorDatabases_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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 vector databases associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCases/{useCaseId}/vectorDatabases/{vectorDatabaseId}/relatedCustomModels/:
    get:
      description: Get a list of custom models that are associated with this vector
        database
      operationId: useCasesVectorDatabasesRelatedCustomModels_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: The ID of the use case this vector database belongs to.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The ID of the vector database.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseVectorDatabaseRelatedCustomModelList'
          description: ''
      summary: Get a list of custom models that are associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.36
  /api/v2/useCases/{useCaseId}/vectorDatabases/{vectorDatabaseId}/relatedDeployments/:
    get:
      description: Get a list of deployments that are associated with this vector
        database
      operationId: useCasesVectorDatabasesRelatedDeployments_list
      parameters:
      - description: The 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.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          exclusiveMinimum: 0
          maximum: 1000
          type: integer
      - description: Filters related deployments by target type.
        in: query
        name: targetType
        required: false
        schema:
          enum:
          - Binary
          - Regression
          - Multiclass
          - Anomaly
          - Transform
          - TextGeneration
          - GeoPoint
          - Unstructured
          - VectorDatabase
          - AgenticWorkflow
          - MCP
          - Multilabel
          type: string
      - description: Filters related deployments by deployment status.
        in: query
        name: status
        required: false
        schema:
          enum:
          - active
          - archived
          - errored
          - inactive
          - launching
          - replacingModel
          - stopping
          type: string
      - description: Indicates if IDs of champion registered model and champion custom
          model for each deployment should be returned
        in: query
        name: includeModelInfo
        required: true
        schema:
          default: false
          type: boolean
      - description: The ID of the use case this vector database belongs to.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The ID of the vector database.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseVectorDatabaseRelatedDeploymentList'
          description: ''
      summary: Get a list of deployments that are associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.36
  /api/v2/useCases/{useCaseId}/vectorDatabases/{vectorDatabaseId}/relatedRegisteredModels/:
    get:
      description: Get a list of registered models that are associated with this vector
        database
      operationId: useCasesVectorDatabasesRelatedRegisteredModels_list
      parameters:
      - description: The 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: 0
          maximum: 100
          type: integer
      - description: The ID of the use case this vector database belongs to.
        in: path
        name: useCaseId
        required: true
        schema:
          type: string
      - description: The ID of the vector database.
        in: path
        name: vectorDatabaseId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseVectorDatabaseRelatedRegisteredModelList'
          description: ''
      summary: Get a list of registered models that are associated by use case ID
      tags:
      - use_cases
      x-versionadded: v2.36
  /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
          - files
          - notebooks
          - applications
          - recipes
          - syftrSearchInstances
          - embeddingModelValidations
          - customModelVersions
          - registeredModelVersions
          - deployments
          - customApplications
          - customJobs
          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.
      summary: Remove a related entity by use case ID
      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
          - files
          - notebooks
          - applications
          - recipes
          - syftrSearchInstances
          - embeddingModelValidations
          - customModelVersions
          - registeredModelVersions
          - deployments
          - customApplications
          - customJobs
          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/UseCasesProjectMigrationParam'
      responses:
        '200':
          description: ''
      summary: Move entity from one Use Case by use case ID
      tags:
      - use_cases
      x-versionadded: v2.35
    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
          - files
          - notebooks
          - applications
          - recipes
          - syftrSearchInstances
          - embeddingModelValidations
          - customModelVersions
          - registeredModelVersions
          - deployments
          - customApplications
          - customJobs
          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 by use case ID
      tags:
      - use_cases
      x-versionadded: v2.32
  /api/v2/useCasesWithShortenedInfo/:
    get:
      description: Retrieves the list of use cases using a new endpoint that abbreviates
        the display metadata for faster retrieval.
      operationId: useCasesWithShortenedInfo_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: 0
          maximum: 100
          type: integer
      - description: Returns only Use Cases with names that match the given string.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: Only return experiment containers associated with the given project
          ID.
        in: query
        name: projectId
        required: false
        schema:
          type: string
        x-versiondeprecated: v2.35
      - description: Only return experiment containers associated with the given app.
        in: query
        name: applicationId
        required: false
        schema:
          type: string
        x-versiondeprecated: v2.35
      - description: The id of the entity type that is linked with the Use Case.
        in: query
        name: entityId
        required: false
        schema:
          type: string
      - description: The entity type that is linked to the use case.
        in: query
        name: entityType
        required: false
        schema:
          enum:
          - project
          - dataset
          - file
          - notebook
          - application
          - recipe
          - playground
          - vectorDatabase
          - syftrSearchInstance
          - embeddingModelValidation
          - customModelVersion
          - registeredModelVersion
          - deployment
          - customApplication
          - customJob
          type: string
      - description: '[DEPRECATED - replaced with order_by] The order in which Use
          Cases and return Use Cases.'
        in: query
        name: sort
        required: true
        schema:
          default: id
          enum:
          - -applicationsCount
          - -createdAt
          - -createdBy
          - -customApplicationsCount
          - -datasetsCount
          - -description
          - -filesCount
          - -id
          - -name
          - -notebooksCount
          - -playgroundsCount
          - -potentialValue
          - -projectsCount
          - -riskLevel
          - -stage
          - -updatedAt
          - -updatedBy
          - -vectorDatabasesCount
          - applicationsCount
          - createdAt
          - createdBy
          - customApplicationsCount
          - datasetsCount
          - description
          - filesCount
          - id
          - name
          - notebooksCount
          - playgroundsCount
          - potentialValue
          - projectsCount
          - riskLevel
          - stage
          - updatedAt
          - updatedBy
          - vectorDatabasesCount
          type: string
        x-versiondeprecated: v2.32
      - description: The order in which use cases are returned.
        in: query
        name: orderBy
        required: true
        schema:
          default: id
          enum:
          - -applicationsCount
          - -createdAt
          - -createdBy
          - -customApplicationsCount
          - -datasetsCount
          - -description
          - -filesCount
          - -id
          - -name
          - -notebooksCount
          - -playgroundsCount
          - -potentialValue
          - -projectsCount
          - -riskLevel
          - -stage
          - -updatedAt
          - -updatedBy
          - -vectorDatabasesCount
          - applicationsCount
          - createdAt
          - createdBy
          - customApplicationsCount
          - datasetsCount
          - description
          - filesCount
          - id
          - name
          - notebooksCount
          - playgroundsCount
          - potentialValue
          - projectsCount
          - riskLevel
          - stage
          - updatedAt
          - updatedBy
          - vectorDatabasesCount
          type: string
      - description: A filter to return use cases by type.
        in: query
        name: usecaseType
        required: true
        schema:
          default: all
          enum:
          - all
          - general
          - walkthrough
          type: string
      - description: Only return Use Cases associated with the given risk level.
        in: query
        name: riskLevel
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 10
            type: array
      - description: Only return use cases in the given stage.
        in: query
        name: stage
        required: false
        schema:
          oneOf:
          - type: string
          - items:
              type: string
            maxItems: 7
            type: array
      - description: Filter Use Cases to return only those created by the selected
          user.
        in: query
        name: createdBy
        required: false
        schema:
          type: string
      - description: Defines if the Use Cases available on Organization level should
          be shown.
        in: query
        name: showOrgUseCases
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UseCaseListWithShortenedInfoResponse'
          description: The use cases with abbreviated metadata were retrieved successfully.
        '403':
          description: User does not have access to this functionality.
      summary: Use an endpoint
      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: The 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
      - data_registry
      x-versionadded: v2.28
    get:
      description: Fetch the 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
      - data_registry
      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
      - data_registry
      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
      tags:
      - blueprints
      - data_registry
      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
      tags:
      - blueprints
      - data_registry
      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
      - data_registry
      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 by user blueprint ID
      tags:
      - blueprints
      - data_registry
      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 by user blueprint ID
      tags:
      - blueprints
      - data_registry
      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 by user blueprint ID
      tags:
      - blueprints
      - data_registry
      x-versionadded: v2.27
  /api/v2/userBlueprints/{userBlueprintId}/sharedRoles/:
    get:
      description: Get the list of users, groups and organizations that have 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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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 the list of users, groups and organizations by user blueprint ID
      tags:
      - blueprints
      - data_registry
      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 by user blueprint ID
      tags:
      - blueprints
      - data_registry
      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
      - data_registry
      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
      - data_registry
      x-versionadded: v2.27
  /api/v2/userBlueprintsProjectBlueprints/:
    post:
      description: Add the 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
      tags:
      - blueprints
      - data_registry
      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
      - data_registry
      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
      tags:
      - blueprints
      - data_registry
      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
      - data_registry
      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 by status ID
      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 by status ID
      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 by status ID
      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 by status ID
      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:
        '204':
          description: Report is deleted.
        '422':
          description: Invalid data
      summary: Delete users permanent delete report by report ID
      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 by report ID
      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 by report ID
      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 by report ID
      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:
        '204':
          description: Report is deleted.
        '422':
          description: Invalid data
      summary: Delete user cleanup summaries by id
      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 by report ID
      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: Retrieve delete params by id
      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 by report ID
      tags:
      - user_management
      x-versionadded: v2.26
  /api/v2/userMCPServerDeployments/{mcpServerDeploymentId}/prompts/:
    get:
      description: List MCP prompts under one MCP server deployment.
      operationId: userMCPServerDeploymentsPrompts_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMCPServerDeploymentPromptsListResponse'
          description: User MCP prompts
      summary: List MCP prompts under one MCP server deployment by mcp server deployment
        ID
      tags:
      - features
      x-versionadded: v2.46
    post:
      description: Add one record of MCP prompt under one MCP server deployment.
      operationId: userMCPServerDeploymentsPrompts_create
      parameters:
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMCPServerDeploymentPromptCreationPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPServerDeploymentPrompt'
          description: User MCP prompt
        '404':
          description: MCP server deployment is not found.
        '409':
          description: MCP prompt to create already exists.
      summary: Add one MCP prompt under one user MCP server deployment by mcp server
        deployment ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerDeployments/{mcpServerDeploymentId}/prompts/{mcpPromptId}/:
    delete:
      description: Delete one MCP prompt under one MCP server deployment.
      operationId: userMCPServerDeploymentsPrompts_delete
      parameters:
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      - description: MCP prompt id
        in: path
        name: mcpPromptId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Delete one MCP prompt under one MCP server deployment by mcp server
        deployment ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerDeployments/{mcpServerDeploymentId}/resources/:
    get:
      description: List MCP resources under one MCP server deployment.
      operationId: userMCPServerDeploymentsResources_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMCPServerDeploymentResourcesListResponse'
          description: User MCP resources
      summary: List MCP resources under one MCP server deployment by mcp server deployment
        ID
      tags:
      - features
      x-versionadded: v2.46
    post:
      description: Add one record of MCP resource under one MCP server deployment.
      operationId: userMCPServerDeploymentsResources_create
      parameters:
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMCPServerDeploymentResourceCreationPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPServerDeploymentResource'
          description: User MCP resource
        '404':
          description: MCP server deployment is not found.
        '409':
          description: MCP resource to create already exists.
      summary: Add one MCP resource under one user MCP server deployment by mcp server
        deployment ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerDeployments/{mcpServerDeploymentId}/resources/{mcpResourceId}/:
    delete:
      description: Delete one MCP resource under one MCP server deployment.
      operationId: userMCPServerDeploymentsResources_delete
      parameters:
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      - description: MCP resource id
        in: path
        name: mcpResourceId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Delete one MCP resource under one MCP server deployment by mcp server
        deployment ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerDeployments/{mcpServerDeploymentId}/tools/:
    get:
      description: List MCP tools under one MCP server deployment.
      operationId: userMCPServerDeploymentsTools_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMCPServerDeploymentToolsListResponse'
          description: User MCP tools
      summary: List MCP tools under one MCP server deployment by mcp server deployment
        ID
      tags:
      - features
      x-versionadded: v2.46
    post:
      description: Add one record of MCP tool under one MCP server deployment.
      operationId: userMCPServerDeploymentsTools_create
      parameters:
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMCPServerDeploymentToolCreationPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPServerDeploymentTool'
          description: User MCP tool
        '404':
          description: MCP server deployment is not found.
        '409':
          description: MCP tool to create already exists.
      summary: Add one MCP tool under one user MCP server deployment by mcp server
        deployment ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerDeployments/{mcpServerDeploymentId}/tools/{mcpToolId}/:
    delete:
      description: Delete one MCP tool under one MCP server deployment.
      operationId: userMCPServerDeploymentsTools_delete
      parameters:
      - description: User MCP server deployment id
        in: path
        name: mcpServerDeploymentId
        required: true
        schema:
          type: string
      - description: MCP tool id
        in: path
        name: mcpToolId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Delete one MCP tool under one MCP server deployment by mcp server deployment
        ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerVersions/{mcpServerVersionId}/prompts/:
    get:
      description: Lists the MCP prompts under one MCP server version.
      operationId: userMCPServerVersionsPrompts_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The user MCP server version ID (custom model version ID).
        in: path
        name: mcpServerVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMCPServerVersionPromptsListResponse'
          description: The list of user MCP prompts.
      summary: List the MCP prompts under one MCP server version by mcp server version
        ID
      tags:
      - features
      x-versionadded: v2.46
    post:
      description: Adds one record of an MCP prompt under one MCP server version.
      operationId: userMCPServerVersionsPrompts_create
      parameters:
      - description: The user MCP server version ID (custom model version ID).
        in: path
        name: mcpServerVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMCPServerVersionPromptsCreationPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPServerVersionPrompt'
          description: The user MCP prompt.
        '404':
          description: The MCP server version was not found.
        '409':
          description: The MCP prompt to create already exists.
      summary: Add one MCP prompt under one user MCP server version by mcp server
        version ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerVersions/{mcpServerVersionId}/resources/:
    get:
      description: Lists the MCP resources under one MCP server version.
      operationId: userMCPServerVersionsResources_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The user MCP server version ID (custom model version ID).
        in: path
        name: mcpServerVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMCPServerVersionResourcesListResponse'
          description: The list of user MCP resources.
      summary: List the MCP resources under one MCP server version by mcp server version
        ID
      tags:
      - features
      x-versionadded: v2.46
    post:
      description: Add one record of an MCP resource under one MCP server version.
      operationId: userMCPServerVersionsResources_create
      parameters:
      - description: The user MCP server version ID (custom model version ID).
        in: path
        name: mcpServerVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMCPServerVersionResourcesCreationPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPServerVersionResource'
          description: The user MCP resource.
        '404':
          description: The MCP server version was not found.
        '409':
          description: The MCP resource to create already exists.
      summary: Add one MCP resource under one user MCP server version by mcp server
        version ID
      tags:
      - features
      x-versionadded: v2.46
  /api/v2/userMCPServerVersions/{mcpServerVersionId}/tools/:
    get:
      description: Lists the MCP tools under one MCP server version.
      operationId: userMCPServerVersionsTools_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          type: integer
      - description: The user MCP server version ID (custom model version ID).
        in: path
        name: mcpServerVersionId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMCPServerVersionToolsListResponse'
          description: The list of user MCP tools.
      summary: List the MCP tools under one MCP server version by mcp server version
        ID
      tags:
      - features
      x-versionadded: v2.46
    post:
      description: Adds one record of an MCP tool under one MCP server version.
      operationId: userMCPServerVersionsTools_create
      parameters:
      - description: The user MCP server version ID (custom model version ID).
        in: path
        name: mcpServerVersionId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMCPServerVersionToolsCreationPayload'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPServerVersionTool'
          description: The user MCP tool.
        '404':
          description: The MCP server version was not found.
        '409':
          description: The MCP tool to create already exists.
      summary: Add one MCP tool under one user MCP server version by mcp server version
        ID
      tags:
      - features
      x-versionadded: v2.46
  /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: The list of the 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: 0
          maximum: 1000
          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: The list of 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 notifications 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 by user notification ID
      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 by user notification ID
      tags:
      - notifications
      x-versionadded: v2.23
  /api/v2/users/:
    get:
      description: Retrieve a list of existing users.
      operationId: users_list
      parameters:
      - description: The 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: 0
          maximum: 1000
          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: Boolean return invited or joined users
        in: query
        name: invited
        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':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListResponse'
          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
      tags:
      - user_management
      x-versionadded: v2.19
  /api/v2/users/invite/:
    post:
      description: Invite multiple users by email to join the platform. Users can
        have non-builder or regular roles.Resources can be specified to be shared
        with the invited users upon acceptance of the invite.
      operationId: usersInvite_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUserInvite'
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUserInviteResponse'
          description: If the status code is 202, the header contains a 'Location'
            url to poll for the invite job status. :http:get:`/api/v2/status/(statusId)/`.
        '403':
          description: Forbidden for non-administrators.
        '422':
          description: Request data is invalid or users with the provided emails already
            exist.
      summary: Invite multiple users by email
      tags:
      - user_management
      x-versionadded: v2.41
  /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':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRetrieveResponse'
          description: Info of requested user.
        '403':
          description: Forbidden for non-administrators.
        '404':
          description: User not found.
      summary: Retrieve a single user by id by user 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 by user ID
      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 by user ID
      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: Delete rate limit usage by id
      tags:
      - analytics
      x-versionadded: v2.0
  /api/v2/valueTrackerValueTemplates/:
    get:
      description: List available value tracker templates.
      operationId: valueTrackerValueTemplates_list
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ValueTrackerValueTemplateResponse'
                type: array
          description: ''
      summary: List available value tracker 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 by templatetype
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackerValueTemplates/{templateType}/calculation/:
    get:
      description: Calculate the value of the template with the 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 the value of the template by templatetype
      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: 0
          maximum: 100
          type: integer
      - description: Sort the value trackers by a field of the value tracker.
        in: query
        name: orderBy
        required: false
        schema:
          enum:
          - businessImpact
          - -businessImpact
          - potentialValue
          - -potentialValue
          - realizedValue
          - -realizedValue
          - feasibility
          - -feasibility
          - stage
          - -stage
          type: string
      - description: Only return value trackers 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 value trackers.
        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 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 by value tracker ID
      tags:
      - value_tracker
      x-versionadded: v2.31
    get:
      description: Retrieve a value tracker.
      operationId: valueTrackers_retrieve
      parameters:
      - description: The ID of the 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 by value tracker ID
      tags:
      - value_tracker
      x-versionadded: v2.31
    patch:
      description: Update a value tracker.
      operationId: valueTrackers_patch
      parameters:
      - description: The ID of the 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 by value tracker ID
      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: 0
          maximum: 100
          type: integer
      - description: The ID of the 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 by value tracker ID
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/attachments/:
    get:
      description: Get the 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: 0
          maximum: 100
          type: integer
      - description: The value tracker attachment type.
        in: query
        name: type
        required: false
        schema:
          enum:
          - dataset
          - modelingProject
          - deployment
          - customModel
          - modelPackage
          - application
          type: string
      - description: The ID of the 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 the list of resources attached by value tracker ID
      tags:
      - value_tracker
      x-versionadded: v2.31
    post:
      description: Attach the list of resources to this value tracker.
      operationId: valueTrackersAttachments_create
      parameters:
      - description: The ID of the 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 the list of resources by value tracker ID
      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 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 by value tracker ID
      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 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 by value tracker ID
      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
          type:
          - string
          - 'null'
      - 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
          type:
          - string
          - 'null'
      - 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 by value tracker ID
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/valueTrackers/{valueTrackerId}/sharedRoles/:
    get:
      description: Get the list of users, groups and organizations that have 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: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          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 the list of users, groups and organizations that have access by
        value tracker ID
      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 were updated successfully.
        '422':
          description: The request was formatted improperly.
      summary: Share a value tracker by value tracker ID
      tags:
      - value_tracker
      x-versionadded: v2.31
  /api/v2/vcs/git/providers/:
    get:
      deprecated: false
      description: List authorized Git OAuth Providers.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGitProvidersResponse'
          description: A list of authorized Git OAuth providers available for the
            user.
      summary: Retrieve Providers
      tags:
      - notebooks
  /api/v2/vcs/git/providers/{authorizationId}/repositories/:
    get:
      deprecated: false
      description: Get or search repositories for a given authorized Git provider.
      parameters:
      - deprecated: false
        description: The authorization ID of the Git provider.
        in: path
        name: authorizationId
        required: true
        schema:
          title: Authorizationid
          type: string
      - allowEmptyValue: false
        allowReserved: false
        deprecated: false
        description: The possible query params to use when listing git repositories.
        in: query
        name: ListGitRepositoryQuery
        required: false
        schema:
          $ref: '#/components/schemas/ListGitRepositoryQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGitRepositoriesResponse'
          description: 'A list of Git repositories available for the authorized Git
            provider and the related params used for filtering

            (if provided).'
      summary: Retrieve Repositories by authorization ID
      tags:
      - notebooks
  /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
  /artifactRepositories:
    get:
      description: Returns the list of artifact repositories.
      operationId: listArtifactRepositories
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      - description: Filters by those created by the given user.
        in: query
        name: createdBy
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filters by those created by the given user.
          title: Created By
      - description: Filter by specific IDs
        in: query
        name: ids
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Filter by specific IDs
          title: Ids
      - description: Case insensitive search against name, description and partial
          ID.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 100
            type: string
          - type: 'null'
          description: Case insensitive search against name, description and partial
            ID.
          title: Search
      - description: List of tag keys to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagKeys
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag keys to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Keys
      - description: List of tag values to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagValues
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag values to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Values
      - description: Select a sorting strategy from the list.
        in: query
        name: orderBy
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/CommonSortQueryParams'
          - type: 'null'
          description: Select a sorting strategy from the list.
          title: Order By
      - description: Filters artifacts by their type (e.g., service, nim).
        in: query
        name: type
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ArtifactType'
          - type: 'null'
          description: Filters artifacts by their type (e.g., service, nim).
          title: Type
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactRepositoryListResponse'
          description: Successful Response
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Artifact Repositories
      tags:
      - artifacts
  /artifactRepositories/{artifact_repository_id}:
    delete:
      description: Delete an artifact repository. Artifacts within the repository
        are cascade-deleted unless they are locked or still in use by workloads.
      operationId: deleteArtifactRepository
      parameters:
      - description: Artifact Repository ID
        in: path
        name: artifact_repository_id
        required: true
        schema:
          description: Artifact Repository ID
          title: Artifact Repository Id
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact repository not found
        '409':
          description: Repository contains locked artifacts or artifacts in use by
            workloads
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Artifact Repository by artifact_repository_ ID
      tags:
      - artifacts
    get:
      description: Get a specific artifact repository by ID.
      operationId: getArtifactRepository
      parameters:
      - description: Artifact Repository ID
        in: path
        name: artifact_repository_id
        required: true
        schema:
          description: Artifact Repository ID
          title: Artifact Repository Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactRepositoryFormatted'
          description: Successful Response
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact repository not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Artifact Repository by artifact_repository_ ID
      tags:
      - artifacts
  /artifactRepositories/{artifact_repository_id}/sharedRoles:
    get:
      description: Get artifact repository shared roles. Returns the list of roles
        shared for this artifact repository.
      operationId: listArtifactRepositorySharedRoles
      parameters:
      - description: Artifact Repository ID
        in: path
        name: artifact_repository_id
        required: true
        schema:
          description: Artifact Repository ID
          title: Artifact Repository Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRoleListResponse'
          description: Successful Response
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact repository not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Artifact Repository Shared Roles by artifact_repository_ ID
      tags:
      - artifacts
    patch:
      description: Update artifact repository shared roles. Replaces the current shared
        roles with the provided list.
      operationId: updateArtifactRepositorySharedRoles
      parameters:
      - description: Artifact Repository ID
        in: path
        name: artifact_repository_id
        required: true
        schema:
          description: Artifact Repository ID
          title: Artifact Repository Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdateRequest'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact repository not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Artifact Repository Shared Roles by artifact_repository_ ID
      tags:
      - artifacts
  /artifacts:
    get:
      description: List all artifacts accessible to the authenticated user.
      operationId: listArtifacts
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      - description: Filters by those created by the given user.
        in: query
        name: createdBy
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filters by those created by the given user.
          title: Created By
      - description: Filter by specific IDs
        in: query
        name: ids
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Filter by specific IDs
          title: Ids
      - description: Case insensitive search against name, description and partial
          ID.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 100
            type: string
          - type: 'null'
          description: Case insensitive search against name, description and partial
            ID.
          title: Search
      - description: List of tag keys to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagKeys
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag keys to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Keys
      - description: List of tag values to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagValues
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag values to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Values
      - description: The order to sort the results.
        in: query
        name: orderBy
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ArtifactSortQueryParams'
          - type: 'null'
          description: The order to sort the results.
          title: Orderby
      - description: Filters artifacts by their type (e.g., service, nim).
        in: query
        name: type
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ArtifactType'
          - type: 'null'
          description: Filters artifacts by their type (e.g., service, nim).
          title: Type
      - description: Filters artifacts by their status.
        in: query
        name: status
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ArtifactStatus'
          - type: 'null'
          description: Filters artifacts by their status.
          title: Status
      - description: Filter artifacts by their artifact repository ID
        in: query
        name: repositoryId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter artifacts by their artifact repository ID
          title: Artifact Repository ID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactListResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Artifacts
      tags:
      - artifacts
    post:
      description: Create a new artifact from the provided container specification.
        Artifacts are always created as drafts.
      operationId: createArtifact
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputArtifact'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Artifact
      tags:
      - artifacts
  /artifacts/{artifact_id}:
    delete:
      description: Delete an artifact. Locked artifacts and artifacts with associated
        protons cannot be deleted.
      operationId: deleteArtifact
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '409':
          description: Artifact is locked or currently in use by a workload
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Artifact by artifact_ ID
      tags:
      - artifacts
    get:
      description: Get a specific artifact by ID.
      operationId: getArtifact
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Artifact by artifact_ ID
      tags:
      - artifacts
    patch:
      description: Partially update an artifact. Only the provided fields will be
        updated.
      operationId: patchArtifact
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateArtifactRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Patch Artifact by artifact_ ID
      tags:
      - artifacts
    put:
      description: 'Update an existing artifact.


        Replaces all artifact fields with the provided values.

        For partial updates, use the PATCH endpoint instead.'
      operationId: updateArtifact
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InputArtifact'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Artifact by artifact_ ID
      tags:
      - artifacts
  /artifacts/{artifact_id}/builds:
    get:
      operationId: getArtifactBuildList
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBuildFormattedList'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          description: Bad request
      summary: Get Artifact Build List by artifact_ ID
      tags:
      - artifacts
    post:
      description: Start image build(s) for a draft service artifact (codeRef). Locked
        artifacts are rejected.
      operationId: triggerArtifactBuild
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBuildTriggerResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          description: Invalid state, missing files, or other services error
      summary: Trigger Artifact Build by artifact_ ID
      tags:
      - artifacts
  /artifacts/{artifact_id}/builds/{build_id}:
    delete:
      description: Request cancellation/deletion of an image build for a **draft**
        artifact (immutable when locked).
      operationId: deleteArtifactBuild
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      - description: Workload API artifact image build id, same id returned by trigger
          build
        in: path
        name: build_id
        required: true
        schema:
          description: Workload API artifact image build id, same id returned by trigger
            build
          title: Build Id
          type: string
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          description: Artifact not draft or internal error
      summary: Delete Artifact Build by artifact_ ID
      tags:
      - artifacts
    get:
      operationId: getArtifactBuild
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      - description: Workload API artifact image build id, same id returned by trigger
          build
        in: path
        name: build_id
        required: true
        schema:
          description: Workload API artifact image build id, same id returned by trigger
            build
          title: Build Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageBuildFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          description: Invalid build id or bad request
      summary: Get Artifact Build by artifact_ ID
      tags:
      - artifacts
  /artifacts/{artifact_id}/builds/{build_id}/logs:
    get:
      operationId: getArtifactBuildLogs
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      - description: Workload API artifact image build id, same id returned by trigger
          build
        in: path
        name: build_id
        required: true
        schema:
          description: Workload API artifact image build id, same id returned by trigger
            build
          title: Build Id
          type: string
      responses:
        '200':
          content:
            text/plain:
              schema:
                type: string
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          description: Invalid build id or bad request
      summary: Get Artifact Build Logs by artifact_ ID
      tags:
      - artifacts
  /artifacts/{artifact_id}/clone:
    post:
      description: Clone an existing artifact. Creates a new artifact with the same
        fields as the original.
      operationId: cloneArtifact
      parameters:
      - description: Artifact ID
        in: path
        name: artifact_id
        required: true
        schema:
          description: Artifact ID
          title: Artifact Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactCloneRequest'
              description: Name for the cloned artifact
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Artifact not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Clone Artifact by artifact_ ID
      tags:
      - artifacts
  /new/:
    post:
      description: 'Create a new Memory Space


        tenant_id is bound from the authenticated user''s context; clients cannot
        set or override it.'
      operationId: create_memory_space_new__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMemorySpaceRequest'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemorySpaceResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Memory Space
      tags:
      - agentic_memory
  /workloads:
    get:
      description: List all workloads accessible to the authenticated user.
      operationId: listWorkloads
      parameters:
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      - description: Filters by those created by the given user.
        in: query
        name: createdBy
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filters by those created by the given user.
          title: Created By
      - description: Filter by specific IDs
        in: query
        name: ids
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Filter by specific IDs
          title: Ids
      - description: Case insensitive search against name, description and partial
          ID.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 100
            type: string
          - type: 'null'
          description: Case insensitive search against name, description and partial
            ID.
          title: Search
      - description: List of tag keys to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagKeys
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag keys to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Keys
      - description: List of tag values to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagValues
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag values to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Values
      - description: The order to sort the results.
        in: query
        name: orderBy
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/WorkloadSortQueryParam'
          - type: 'null'
          description: The order to sort the results.
          title: Order By
      - description: Filters workloads by status.
        in: query
        name: status
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/WorkloadStatus'
            type: array
          - type: 'null'
          description: Filters workloads by status.
          title: Status
      - description: Filters workloads by their corresponding artifact status.
        in: query
        name: artifactStatus
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/ArtifactStatus'
            type: array
          - type: 'null'
          description: Filters workloads by their corresponding artifact status.
          title: Artifact Status
      - description: Filters workloads by their importance.
        in: query
        name: importance
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/WorkloadImportance'
            type: array
          - type: 'null'
          description: Filters workloads by their importance.
          title: Importance
      - description: Filter workloads by their active artifact ID.
        in: query
        name: artifactId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter workloads by their active artifact ID.
          title: Artifact ID
      - description: Filter workloads by their active artifact's repository ID.
        in: query
        name: repositoryId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter workloads by their active artifact's repository ID.
          title: Artifact Repository ID
      - description: Filters workloads by artifact type.
        in: query
        name: type
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ArtifactType'
          - type: 'null'
          description: Filters workloads by artifact type.
          title: Type
      - description: If true, includes recent service statistics in the response.
        in: query
        name: serviceStats
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: If true, includes recent service statistics in the response.
          title: Service Statistics
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadListResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: List Workloads
      tags:
      - workloads
    post:
      description: Create a workload from the specified artifact and schedule its
        initial runtime.
      operationId: createWorkload
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkloadRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Workload
      tags:
      - workloads
  /workloads/stats:
    get:
      description: Get aggregated statistics across all workloads accessible to the
        authenticated user.
      operationId: listWorkloadsStats
      parameters:
      - description: Filters by those created by the given user.
        in: query
        name: createdBy
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filters by those created by the given user.
          title: Created By
      - description: Filter by specific IDs
        in: query
        name: ids
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: Filter by specific IDs
          title: Ids
      - description: Case insensitive search against name, description and partial
          ID.
        in: query
        name: search
        required: false
        schema:
          anyOf:
          - maxLength: 100
            type: string
          - type: 'null'
          description: Case insensitive search against name, description and partial
            ID.
          title: Search
      - description: List of tag keys to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagKeys
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag keys to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Keys
      - description: List of tag values to filter for. If multiple values are specified,
          results with tags that match any of the values will be returned.
        in: query
        name: tagValues
        required: false
        schema:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          description: List of tag values to filter for. If multiple values are specified,
            results with tags that match any of the values will be returned.
          title: Tag Values
      - description: The order to sort the results.
        in: query
        name: orderBy
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/WorkloadSortQueryParam'
          - type: 'null'
          description: The order to sort the results.
          title: Order By
      - description: Filters workloads by status.
        in: query
        name: status
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/WorkloadStatus'
            type: array
          - type: 'null'
          description: Filters workloads by status.
          title: Status
      - description: Filters workloads by their corresponding artifact status.
        in: query
        name: artifactStatus
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/ArtifactStatus'
            type: array
          - type: 'null'
          description: Filters workloads by their corresponding artifact status.
          title: Artifact Status
      - description: Filters workloads by their importance.
        in: query
        name: importance
        required: false
        schema:
          anyOf:
          - items:
              $ref: '#/components/schemas/WorkloadImportance'
            type: array
          - type: 'null'
          description: Filters workloads by their importance.
          title: Importance
      - description: Filter workloads by their active artifact ID.
        in: query
        name: artifactId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter workloads by their active artifact ID.
          title: Artifact ID
      - description: Filter workloads by their active artifact's repository ID.
        in: query
        name: repositoryId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter workloads by their active artifact's repository ID.
          title: Artifact Repository ID
      - description: Filters workloads by artifact type.
        in: query
        name: type
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ArtifactType'
          - type: 'null'
          description: Filters workloads by artifact type.
          title: Type
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadStatsResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get All Workloads Stats
      tags:
      - workloads
  /workloads/{workload_id}:
    delete:
      description: 'Delete a workload permanently.


        Returns 204 on success. Proton stop failures are logged internally

        but do not change the response status.'
      operationId: deleteWorkload
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Workload by workload_ ID
      tags:
      - workloads
    get:
      description: Retrieve a workload by ID.
      operationId: getWorkload
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload by workload_ ID
      tags:
      - workloads
    patch:
      description: Partially update a workload's properties.
      operationId: updateWorkload
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkloadRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Workload by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/events:
    get:
      description: List events for a workload, such as status changes and errors.
      operationId: listWorkloadEvents
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadEventsResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Events by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/history:
    get:
      description: List the artifact deployment history for a workload.
      operationId: listWorkloadArtifactHistory
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplacementHistoryListResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Artifact Histories by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/promote:
    post:
      description: 'Lock the draft artifact currently running on a workload.


        The workload continues running the same artifact, which is promoted from

        draft to locked and assigned a version number. Workload stats are reset

        and the event is recorded in the replacement history.'
      operationId: promoteWorkloadArtifact
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          description: Artifact is not a draft, workload has no active proton, or
            a replacement is in progress
      summary: Promote Workload Artifact by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/protons:
    get:
      description: List all protons associated with a workload.
      operationId: listWorkloadProtons
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtonListResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: List Workload Protons by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/protons/{proton_id}:
    get:
      description: Get a specific proton for a workload.
      operationId: getWorkloadProton
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Proton ID
        in: path
        name: proton_id
        required: true
        schema:
          description: Proton ID
          title: Proton Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtonFormatted'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Proton by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/protons/{proton_id}/statusDetails:
    get:
      description: 'Get per-replica status details for a proton.


        Returns 204 if no status update has been received yet.

        Returns 200 with the latest replica snapshot when available.'
      operationId: getWorkloadProtonStatusDetails
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Proton ID
        in: path
        name: proton_id
        required: true
        schema:
          description: Proton ID
          title: Proton Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicaStatusesSnapshot'
          description: Successful Response
        '204':
          description: No status update has been received for this proton yet
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Proton Status Details by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/related:
    get:
      description: List entities related to a workload, such as linked artifacts.
      operationId: getWorkloadRelatedEntities
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelatedEntitiesResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Related Entities by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/replacement:
    delete:
      operationId: deleteWorkloadReplacement
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '202':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Replacement by workload_ ID
      tags:
      - workloads
    get:
      operationId: getWorkloadReplacement
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Replacement'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Replacement by workload_ ID
      tags:
      - workloads
    post:
      operationId: createWorkloadReplacement
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartReplacementRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Replacement'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Replacement by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/settings:
    get:
      description: Retrieve the configuration settings for a workload.
      operationId: getWorkloadSettings
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadSettingsResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Settings by workload_ ID
      tags:
      - workloads
    patch:
      description: Update workload runtime settings by triggering a rolling replacement
        with the current artifact.
      operationId: updateWorkloadSettings
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSettingsRequest'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Replacement'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '409':
          description: A replacement is already in progress for this workload
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Workload Settings by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/sharedRoles:
    get:
      description: List the shared roles granted on a workload.
      operationId: listWorkloadSharedRoles
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: Retrieve only the specified number of values.
          maximum: 100
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedRoleListResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Shared Roles by workload_ ID
      tags:
      - workloads
    patch:
      description: Replace the shared roles for a workload with the provided list.
      operationId: updateWorkloadSharedRoles
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharedRolesUpdateRequest'
        required: true
      responses:
        '204':
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Workload Shared Roles by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/start:
    post:
      description: Start a workload by scheduling its proton.
      operationId: startWorkload
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadOperationResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '409':
          description: Workload proton must be stopped before starting
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Start Workload by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/stats:
    delete:
      description: Clear collected statistics for a workload within the specified
        time range.
      operationId: resetWorkloadStats
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Proton ID to get stats for (optional, defaults to current proton)
        in: query
        name: protonId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Proton ID to get stats for (optional, defaults to current proton)
          title: Proton ID
      - description: Start time for stats
        in: query
        name: startTime
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Start time for stats
          title: Start Time
      - description: End time for stats
        in: query
        name: endTime
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: End time for stats
          title: End Time
      responses:
        '204':
          description: Successful Response
        '400':
          description: Invalid time range
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Reset Workload Stats by workload_ ID
      tags:
      - workloads
    get:
      description: Get aggregated performance statistics for a workload.
      operationId: getWorkloadStats
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Proton ID to get stats for (optional, defaults to current proton)
        in: query
        name: protonId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Proton ID to get stats for (optional, defaults to current proton)
          title: Proton ID
      - description: Start time for stats
        in: query
        name: startTime
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Start time for stats
          title: Start Time
      - description: End time for stats
        in: query
        name: endTime
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: End time for stats
          title: End Time
      - description: Response time quantile (e.g., 0.95 for p95)
        in: query
        name: responseTimeQuantile
        required: false
        schema:
          default: 0.5
          description: Response time quantile (e.g., 0.95 for p95)
          maximum: 1
          minimum: 0
          title: Response Time Quantile
          type: number
      - description: Slow requests threshold in milliseconds
        in: query
        name: slowRequestsThreshold
        required: false
        schema:
          default: 2000
          description: Slow requests threshold in milliseconds
          minimum: 0
          title: Slow Requests Threshold
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtonRequestStats'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Stats by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/stats/{metric_name}:
    get:
      description: Get time-series data for a specific performance metric of a workload.
      operationId: getWorkloadMetricTimeSeries
      parameters:
      - description: Name of the metric to retrieve
        in: path
        name: metric_name
        required: true
        schema:
          $ref: '#/components/schemas/WorkloadStatsMetricName'
          description: Name of the metric to retrieve
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      - description: Proton ID to get stats for (optional, defaults to current proton)
        in: query
        name: protonId
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Proton ID to get stats for (optional, defaults to current proton)
          title: Proton ID
      - description: Start time for stats
        in: query
        name: startTime
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Start time for stats
          title: Start Time
      - description: End time for stats
        in: query
        name: endTime
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: End time for stats
          title: End Time
      - description: Response time quantile (e.g., 0.95 for p95)
        in: query
        name: responseTimeQuantile
        required: false
        schema:
          default: 0.5
          description: Response time quantile (e.g., 0.95 for p95)
          maximum: 1
          minimum: 0
          title: Response Time Quantile
          type: number
      - description: Slow requests threshold in milliseconds
        in: query
        name: slowRequestsThreshold
        required: false
        schema:
          default: 2000
          description: Slow requests threshold in milliseconds
          minimum: 0
          title: Slow Requests Threshold
          type: integer
      - description: Time resolution for data aggregation
        in: query
        name: resolution
        required: false
        schema:
          $ref: '#/components/schemas/OtelMetricResolution'
          default: P1D
          description: Time resolution for data aggregation
          title: Resolution
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProtonRequestMetricOverTime'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workload Stats Per Metric by workload_ ID
      tags:
      - workloads
  /workloads/{workload_id}/stop:
    post:
      description: Stop a workload by stopping its proton.
      operationId: stopWorkload
      parameters:
      - description: Workload ID
        in: path
        name: workload_id
        required: true
        schema:
          description: Workload ID
          title: Workload Id
          type: string
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadOperationResponse'
          description: Successful Response
        '400':
          description: Bad request
        '401':
          description: Unauthenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Workload not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Stop Workload by workload_ ID
      tags:
      - workloads
  /{memory_space_id}/:
    delete:
      description: 'Delete a Memory Space


        Returns 404 if already deleted or not accessible by the caller'
      operationId: delete_memory_space__memory_space_id___delete
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '204':
          description: Successful Response
        '404':
          description: Memory Space not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Memory Space by memory_space_ ID
      tags:
      - agentic_memory
    get:
      description: 'Get a Memory Space by ID


        Returns 404 if the space does not exist, is soft-deleted, or not accessible
        by a user.'
      operationId: get_memory_space__memory_space_id___get
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemorySpaceResponse'
          description: Successful Response
        '404':
          description: Memory Space not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Memory Space by memory_space_ ID
      tags:
      - agentic_memory
    patch:
      description: Partially update a Memory Space
      operationId: update_memory_space__memory_space_id___patch
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMemorySpaceRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemorySpaceResponse'
          description: Successful Response
        '404':
          description: Memory Space not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Memory Space by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/sessions/:
    get:
      operationId: list_sessions__memory_space_id__sessions__get
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: Limit
          type: integer
      - description: Filter sessions by participant IDs (ObjectId format).
        in: query
        name: participants
        required: false
        schema:
          anyOf:
          - items:
              type: string
            maxItems: 1
            type: array
          - type: 'null'
          description: Filter sessions by participant IDs (ObjectId format).
          title: Participants
      - description: Filter sessions by description (case-insensitive substring match).
          Must be at least 3 characters.
        in: query
        name: description
        required: false
        schema:
          anyOf:
          - maxLength: 1000
            minLength: 3
            type: string
          - type: 'null'
          description: Filter sessions by description (case-insensitive substring
            match). Must be at least 3 characters.
          title: Description
      - description: Filter sessions by deduplication key (exact match).
        in: query
        name: deduplicationKey
        required: false
        schema:
          anyOf:
          - maxLength: 72
            minLength: 1
            type: string
          - type: 'null'
          description: Filter sessions by deduplication key (exact match).
          title: Deduplicationkey
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_SessionResponse_'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: List Sessions by memory_space_ ID
      tags:
      - agentic_memory
    post:
      operationId: create_session__memory_space_id__sessions__post
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSessionRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
          description: Successful Response
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionDeduplicationErrorResponse'
          description: A session with this `deduplicationKey` already exists in the
            memory space. Body carries `existingSessionId` / `existingSessionUrl`
            when the live winner can be resolved; the response also sets a `Location`
            header to its absolute URL.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Session by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/sessions/{session_id}/:
    delete:
      description: 'Delete a session.


        Performs a soft-delete by setting the deleted_at timestamp.'
      operationId: delete_session__memory_space_id__sessions__session_id___delete
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '204':
          description: Successful Response
        '404':
          description: Session not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Session by memory_space_ ID
      tags:
      - agentic_memory
    get:
      description: Get a single session by ID
      operationId: get_session__memory_space_id__sessions__session_id___get
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
          description: Successful Response
        '404':
          description: Session not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Session by memory_space_ ID
      tags:
      - agentic_memory
    patch:
      description: 'Patch a session with new description and/or metadata.


        Only fields explicitly included in the request body are modified others remain
        untouched'
      operationId: update_session__memory_space_id__sessions__session_id___patch
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - description: Optional optimistic-concurrency precondition. Supply the `version`
          from the prior response (quoted or bare integer, e.g. `"3"` or `3`). Returns
          409 if the stored version no longer matches.
        in: header
        name: If-Match
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional optimistic-concurrency precondition. Supply the `version`
            from the prior response (quoted or bare integer, e.g. `"3"` or `3`). Returns
            409 if the stored version no longer matches.
          title: If-Match
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSessionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
          description: Successful Response
        '404':
          description: Session not found
        '409':
          description: Session version does not match If-Match precondition
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Update Session by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/sessions/{session_id}/events/:
    get:
      operationId: list_events__memory_space_id__sessions__session_id__events__get
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - description: Skip the specified number of values.
        in: query
        name: offset
        required: false
        schema:
          default: 0
          description: Skip the specified number of values.
          minimum: 0
          title: Offset
          type: integer
      - description: Retrieve only the specified number of values.
        in: query
        name: limit
        required: false
        schema:
          default: 100
          description: Retrieve only the specified number of values.
          exclusiveMinimum: 0
          maximum: 100
          title: Limit
          type: integer
      - description: Return the last N events in chronological order. Mutually exclusive
          with offset
        in: query
        name: lastN
        required: false
        schema:
          anyOf:
          - exclusiveMinimum: 0
            maximum: 100
            type: integer
          - type: 'null'
          description: Return the last N events in chronological order. Mutually exclusive
            with offset
          title: Lastn
      - description: Filter session events by type. Omit to return events of all types.
        in: query
        name: eventType
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/EventType'
          - type: 'null'
          description: Filter session events by type. Omit to return events of all
            types.
          title: Eventtype
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_EventResponse_'
          description: Successful Response
        '404':
          description: Session not found
        '422':
          description: Validation error (e.g. lastN used together with offset)
      summary: List Events by memory_space_ ID
      tags:
      - agentic_memory
    post:
      operationId: create_event__memory_space_id__sessions__session_id__events__post
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEventRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
          description: Successful Response
        '404':
          description: Session not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Event by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/sessions/{session_id}/events/batch/:
    patch:
      description: Update up to MAX_BATCH_SIZE events atomically; any failure rolls
        back the batch.
      operationId: update_events_batch__memory_space_id__sessions__session_id__events_batch__patch
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdateEventRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEventResponse'
          description: Successful Response
        '400':
          description: An event emitter is not a session participant
        '404':
          description: Session or one of the events was not found
        '422':
          description: Tried to update an outdated version of an event
      summary: Update Events Batch by memory_space_ ID
      tags:
      - agentic_memory
    post:
      description: Append up to MAX_BATCH_SIZE events to a session atomically.
      operationId: create_events_batch__memory_space_id__sessions__session_id__events_batch__post
      parameters:
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateEventRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEventResponse'
          description: Successful Response
        '400':
          description: An event emitter is not a session participant
        '404':
          description: Session not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Create Events Batch by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/sessions/{session_id}/events/{sequence_id}/:
    delete:
      description: Soft-delete one session event by sequence id.
      operationId: delete_event__memory_space_id__sessions__session_id__events__sequence_id___delete
      parameters:
      - description: Event sequence ID
        in: path
        name: sequence_id
        required: true
        schema:
          description: Event sequence ID
          minimum: 0
          title: Sequence Id
          type: integer
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '204':
          description: Successful Response
        '404':
          description: Session not found or event not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Event by memory_space_ ID
      tags:
      - agentic_memory
    patch:
      operationId: update_event__memory_space_id__sessions__session_id__events__sequence_id___patch
      parameters:
      - description: Event sequence ID
        in: path
        name: sequence_id
        required: true
        schema:
          description: Event sequence ID
          minimum: 0
          title: Sequence Id
          type: integer
      - description: Session ID
        in: path
        name: session_id
        required: true
        schema:
          description: Session ID
          format: uuid
          title: Session Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - description: Verification of target version of event
        in: query
        name: createdAt
        required: false
        schema:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Verification of target version of event
          title: Createdat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEventRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
          description: Successful Response
        '404':
          description: Session or event are not found
        '422':
          description: Try to update outdated version of event
      summary: Update Event by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v1/memories/:
    delete:
      description: 'Delete all memories matching the given filter. At least one filter
        param is required

        to prevent accidental deletion of all memories across all identities.'
      operationId: delete_all_memories__memory_space_id__v1_memories__delete
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - in: query
        name: user_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: User Id
      - in: query
        name: agent_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Agent Id
      - in: query
        name: run_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Run Id
      - in: query
        name: app_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: App Id
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete All Memories by memory_space_ ID
      tags:
      - agentic_memory
    get:
      description: Retrieve all memories matching the given identity filters (v1 query-param
        interface).
      operationId: get_all_memories_v1__memory_space_id__v1_memories__get
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - in: query
        name: user_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: User Id
      - in: query
        name: agent_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Agent Id
      - in: query
        name: run_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: Run Id
      - in: query
        name: app_id
        required: false
        schema:
          anyOf:
          - maxLength: 64
            minLength: 1
            type: string
          - type: 'null'
          title: App Id
      - in: query
        name: top_k
        required: false
        schema:
          anyOf:
          - maximum: 50
            minimum: 1
            type: integer
          - type: 'null'
          title: Top K
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get All Memories V1 by memory_space_ ID
      tags:
      - agentic_memory
    post:
      description: Extract facts from a conversation and persist them as memories.
      operationId: post_memories__memory_space_id__v1_memories__post
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemoryCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '409':
          description: Immutable memory with the same content already exists.
        '422':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/HTTPValidationError'
                - properties:
                    detail:
                      oneOf:
                      - type: string
                      - type: object
                  required:
                  - detail
                  type: object
          description: Validation error (request body) or domain conflict (content
            mismatch).
        '503':
          description: Transient condition (insert conflict or upstream LLM rate limit);
            retry advised.
          headers:
            Retry-After:
              schema:
                type: integer
      summary: Post Memories by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v1/memories/search/:
    post:
      description: Search memories by semantic similarity to a query string.
      operationId: search_memories_v1__memory_space_id__v1_memories_search__post
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemorySearch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Search Memories V1 by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v1/memories/{memory_id}/:
    delete:
      description: Delete a single memory by its ID.
      operationId: delete_memory__memory_space_id__v1_memories__memory_id___delete
      parameters:
      - in: path
        name: memory_id
        required: true
        schema:
          format: uuid
          title: Memory Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Memory by memory_space_ ID
      tags:
      - agentic_memory
    get:
      description: Retrieve a single memory by its ID. Returns null if the memory
        does not exist.
      operationId: get_memory__memory_space_id__v1_memories__memory_id___get
      parameters:
      - in: path
        name: memory_id
        required: true
        schema:
          format: uuid
          title: Memory Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Memory by memory_space_ ID
      tags:
      - agentic_memory
    put:
      description: 'Replace the text of an existing memory.

        Returns 404 if the memory does not exist.

        Returns 409 if the memory is immutable.'
      operationId: put_memory__memory_space_id__v1_memories__memory_id___put
      parameters:
      - in: path
        name: memory_id
        required: true
        schema:
          format: uuid
          title: Memory Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemoryUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '404':
          description: Memory not found.
        '409':
          description: Memory is immutable and cannot be updated.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Put Memory by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v1/memories/{memory_id}/history/:
    get:
      description: Retrieve the mutation history (audit trail) for a single memory.
      operationId: get_memory_history__memory_space_id__v1_memories__memory_id__history__get
      parameters:
      - in: path
        name: memory_id
        required: true
        schema:
          format: uuid
          title: Memory Id
          type: string
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - in: query
        name: limit
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Memory History by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v1/ping/:
    get:
      description: Health check endpoint returning fake user context for mem0.MemoryClient
        compatibility.
      operationId: ping__memory_space_id__v1_ping__get
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Ping by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v1/reset/:
    post:
      description: Delete all memories in the current memory space.
      operationId: reset_memories__memory_space_id__v1_reset__post
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Reset Memories by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v2/memories/:
    post:
      description: 'Retrieve all memories matching the given filters.


        At least one of user_id, agent_id, or run_id is required (as enforced by mem0''s
        AsyncMemory)'
      operationId: get_all_memories_v2__memory_space_id__v2_memories__post
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      - in: query
        name: page_size
        required: false
        schema:
          anyOf:
          - maximum: 50
            minimum: 1
            type: integer
          - type: 'null'
          title: Page Size
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemoryGetAll'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '400':
          description: At least one of user_id, agent_id, or run_id must be provided.
        '422':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/HTTPValidationError'
                - properties:
                    detail:
                      oneOf:
                      - type: string
                      - type: object
                  required:
                  - detail
                  type: object
          description: Validation error (request body) or domain conflict (content
            mismatch).
      summary: Get All Memories V2 by memory_space_ ID
      tags:
      - agentic_memory
  /{memory_space_id}/v2/memories/search/:
    post:
      description: 'Search memories by semantic similarity to a query string.


        At least one of user_id, agent_id, or run_id is required to scope the search.'
      operationId: search_memories_v2__memory_space_id__v2_memories_search__post
      parameters:
      - description: Memory Space ID
        in: path
        name: memory_space_id
        required: true
        schema:
          description: Memory Space ID
          title: Memory Space Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemorySearch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
          description: Successful Response
        '400':
          description: At least one of user_id, agent_id, or run_id must be provided.
        '422':
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/HTTPValidationError'
                - properties:
                    detail:
                      oneOf:
                      - type: string
                      - type: object
                  required:
                  - detail
                  type: object
          description: Validation error (request body) or domain conflict (content
            mismatch).
      summary: Search Memories V2 by memory_space_ ID
      tags:
      - agentic_memory
security:
- BearerAuth: []
servers:
- url: https://app.datarobot.com/
tags:
- description: Endpoints for notebooks which offer an in-browser editor to create
    and execute code for data science analysis and modeling.
  name: notebooks
- description: Manage AI workload deployments and their lifecycle.
  name: workloads
- description: Manage artifact definitions and container specifications.
  name: artifacts
- description: Manage versioned repositories of related artifacts.
  name: artifactRepositories
- description: Internal Covalent scheduling callbacks. Not for external use.
  name: protons
- description: Endpoints for managing agentic memory spaces, sessions, and events.
  name: agentic_memory
- description: The following endpoints outline how to manage AI robustness tests.
  name: AI Robustness Tests
- description: The following endpoints outline how to manage LLM generation.
  name: LLM Generation
- description: The following endpoints outline how to manage prompts.
  name: Prompting
- description: The following endpoints outline how to manage vector databases.
  name: Vector Databases
- description: The following endpoints outline how to manage agents.
  name: Agents
- description: Use the endpoints described below to manage access control settings.
    These endpoints control access to the DataRobot application by assigning users
    roles with designated privileges. Role-based permissions and role-role relationships
    make it simple to assign the appropriate permissions the specific ways in which
    users intend to use the application.
  name: access_control
- description: Use the endpoints described below to manage accuracy. Accuracy allows
    you to analyze the performance of model deployments over time using standard statistical
    measures and exportable visualizations. Use this tool to determine whether a model's
    quality is decaying and if you should consider replacing it.
  name: accuracy
- description: Use the endpoints described below to discover agents registered within
    the platform and manage agent cards.
  name: agent_cards
- description: Use the endpoints described below to register tools to an MCP Server
    deployment.
  name: agentic_tools
- description: Use the endpoints described below to manage AI Catalog. This is a central
    catalog for your datasets that lists all static and snapshot datasets you currently
    have access to in the AI Catalog, including those uploaded from [local files](wb-local-file)
    and [data connections](wb-connect) in Workbench.
  name: ai_catalog
- description: Use the endpoints described below to manage Apache Airflow instances.
  name: airflow_instances
- description: Use analytics endpoints to retrieve and audit and event logs.
  name: analytics
- description: Use the endpoints described below to manage application templates.
  name: application_templates
- description: Use the endpoints described below to manage applications.
  name: applications
- description: This page describes the endpoints for enacting workflow requirements
    to ensure quality and comply with regulatory obligations. When you create a new
    or change an existing deployment, if the approval workflow is enabled, an MLOps
    administrator within your organization must approve your changes. [Approval policies](deploy-approval)
    affect the users who have permissions to review deployments and provide automated
    actions when reviews time out. Approval policies also affect users whose deployment
    events are governed by a configured policy (e.g., new deployment creation, model
    replacement).
  name: approval_workflows
- description: Use assets endpoints to retrieve and filter the assets available for
    the user.
  name: assets
- description: Use the endpoints described below to manage batch monitoring. You can
    view monitoring statistics organized by batch, instead of by time, with batch-enabled
    deployments. To do this, you can create batches, add predictions to those batches,
    and view service health, data drift, and accuracy statistics for the batches in
    your deployment.
  name: batch_monitoring
- description: Use the endpoints described below to generate predictions for a project.
  name: batch_predictions
- description: Use the endpoints described below to manage bias and fairness. Bias
    and Fairness testing provides methods to calculate fairness for a binary classification
    model and attempt to identify any biases in the model's predictive behavior. In
    DataRobot, bias represents the difference between a model's predictions for different
    populations (or groups) while fairness is the measure of the model's bias. Select
    protected features in the dataset and choose fairness metrics and mitigation techniques
    either [before model building](fairness-metrics#configure-metrics-and-mitigation-pre-autopilot)
    or [from the Leaderboard](fairness-metrics#configure-metrics-and-mitigation-post-autopilot)
    once models are built. [Bias and Fairness insights](bias/index) help identify
    bias in a model and visualize the root-cause analysis, explaining why the model
    is learning bias from the training data and from where.
  name: bias_and_fairness
- 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: This page outlines DataRobot's endpoints for customizing Customer-Branded
    Themes for the DataRobot application.
  name: branded_themes
- description: Use the endpoints described below to manage challenger models. MLOps
    allows you to compare challenger models against each other and against the currently
    deployed model (the "champion") to ensure that your deployment uses the best model
    for your needs. After evaluating DataRobot's model comparison visualizations,
    you can replace the champion model with a better-performing challenger. DataRobot
    renders visualizations based on a dedicated comparison dataset, which you select,
    ensuring that you're comparing predictions based on the same dataset and partition
    while still allowing you to train champion and challenger models on different
    datasets. For example, you may train a challenger model on an updated snapshot
    of the same data source used by the champion.
  name: challenger_models
- description: The following endpoints outline how to add comments and host discussion
    for a model.
  name: comments
- description: DataRobot automates many critical compliance tasks associated with
    developing a model and, by doing so, decreases the time-to-deployment in highly
    regulated industries. You can generate, for each model, individualized documentation
    to provide comprehensive guidance on what constitutes effective model risk management.
    Then, you can download the report as an editable Microsoft Word document (.docx).
    The generated report includes the appropriate level of information and transparency
    necessitated by regulatory compliance demands.
  name: compliance_documentation
- description: The following endpoints outline how to manage user credentials.
  name: credentials
- description: Use the endpoints described below to manage custom applications.
  name: custom_applications
- description: Use the endpoints described below to manage custom jobs. Use custom
    jobs to implement automation (for example, custom tests) for your models and deployments.
    Each job serves as an automated workload, and the exit code determines if it passed
    or failed. You can run the custom jobs you create for one or more models or deployments.
    The automated workloads you define through custom jobs can make prediction requests,
    fetch inputs, and store outputs using DataRobot's Public API.
  name: custom_jobs
- description: Use the endpoints described below to manage custom metrics.
  name: custom_metrics
- description: Assemble, test and deploy your own custom model with a custom environment.
  name: custom_models
- description: Use the endpoints described below to manage custom scoring metrics.
  name: custom_scoring_metrics
- 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
- description: This page outlines how to integrate with a variety of enterprise databases,
    using a 'self-service' JDBC platform.
  name: data_connectivity
- description: Use the endpoints described below to manage data exports and tracing.
  name: data_exports_and_tracing
- description: Read below to learn about DataRobot's endpoints for managing data,
    including topics such as the Data Registry, datasets, feature lists, and blueprints.
    Reference the [Glossary](glossary/index) and UI documentation for more information
    about these topics.
  name: data_registry
- description: This page outlines the operations and endpoints for data wrangling
    (preparation).
  name: data_wrangling
- description: Use the endpoints described below to manage DataRobot models.
  name: datarobot_models
- description: The endpoints below outline how to create and manage data source definitions.
  name: dataset_definition
- description: This page outlines how to organize partitioning for model events that
    take place over time.
  name: datetime_partitioning
- description: Use the endpoints described below to manage deployment configuration.
    Configure capabilities of your current deployment based on the data provided,
    for example, training data, prediction data, or actuals. After you create and
    configure a deployment, you can use the deployment settings to add or update deployment
    functionality that wasn't configured during deployment creation.
  name: deployment_configuration
- description: Use the endpoints described below to manage deployment information,
    such as the deployment ID, importance levels, approval status, and more.
  name: deployment_info
- description: Use the endpoints described below to manage deployments.
  name: deployment_management
- description: Use the endpoints described below to manage deployment model replacement.
  name: deployment_model_replacement
- description: Use the endpoints described below to manage deployment runtime parameters
    for deployed custom models.
  name: deployment_runtime_parameters
- 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 endpoints described below to manage documentation.
  name: documentation
- description: Use the endpoints described below to manage drift. When deploying a
    model, there is a chance that the dataset used for training and validation differs
    from the prediction data. DataRobot monitors both target and feature drift information.
  name: drift
- description: Use the endpoints described below to manage entitlements.
  name: entitlements
- description: Use the endpoints described below to configure tags for your entities
    (e.g., use cases).
  name: entity_tags
- description: Use the endpoints described below to manage features.
  name: features
- description: Use the endpoints described below to manage governance. When machine
    learning models in production become critical to business functions, new requirements
    emerge to ensure quality and to comply with legal and regulatory obligations.
    The deployment and modification of models can have far-reaching impacts, so establishing
    clear practices can ensure consistent management and minimized risk. Model governance
    sets the rules and controls for deployments, including access control, testing
    and validation, change and access logs, and traceability of prediction results.
    With model governance in place, organizations can scale deployments and provide
    legal and compliance reports.
  name: governance
- description: Use the endpoints described below to manage guardrails. Model guardrails
    are a set of rules or machine learning models that ensure the output of a language
    model is safe, accurate, and ethical.
  name: guardrails
- description: These endpoints retrieve information required for the homepage (e.g.,
    workspace resource centers).
  name: homepage
- description: "Use the endpoints described below to manage humility rules. Humility\
    \ rules enable models to recognize, in real time, when they make uncertain predictions\
    \ or receive data they have not seen before. Unlike data drift, model humility\
    \ does not deal with broad statistical properties over time\u2014it is instead\
    \ triggered for individual predictions, allowing you to set desired behaviors\
    \ with rules that depend on different triggers. Using humility rules to add triggers\
    \ and corresponding actions to a prediction helps mitigate risk for models in\
    \ production. Humility rules help to identify and handle data integrity issues\
    \ during monitoring and to better identify the root cause of unstable predictions."
  name: humility_rules
- 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: Use the endpoints described below to submit and manage profiling jobs
    for active LLM deployments. Each profiling request initiates an asynchronous benchmarking
    job that collects token-level performance metrics from the target deployment.
    Profiling generates significant load and must not be executed against deployments
    serving live production traffic.
  name: llm_profiling_jobs
- description: Use the endpoints described below to manage challenger models.
  name: mitigation_challenger_models
- description: Use the endpoints described below to manage humility.
  name: mitigation_humility
- description: Use the endpoints described below to manage retraining. To maintain
    model performance after deployment without extensive manual work, DataRobot provides
    an automatic retraining capability for deployments. Upon providing a retraining
    dataset registered in the Data Registry, you can define up to five retraining
    policies on each deployment. Each policy consists of a trigger, a modeling strategy,
    modeling settings, and a replacement action. When triggered, retraining will produce
    a new model based on these settings and notify you to consider promoting it.
  name: mitigation_retraining
- 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 for model management.
  name: model_management
- description: Use the endpoints described below to create and manage DataRobot models.
  name: models
- description: 'Use the endpoints described below to manage monitoring jobs. To integrate
    more closely with external data sources, monitoring job definitions allow DataRobot
    to monitor deployments running and storing feature data and predictions outside
    of DataRobot. For example, you can create a monitoring job to connect to Snowflake,
    fetch raw data from the relevant Snowflake tables, and send the data to DataRobot
    for monitoring purposes. '
  name: monitoring_jobs
- description: Read below to learn about DataRobot's endpoints for no-code applications.
    Reference the [AI App Builder](app-builder/index) documentation for more information.
  name: no_code_applications
- description: This page outlines how to manage notifications received by users.
  name: notifications
- description: Use the endpoints described below to manage accuracy. Accuracy allows
    you to analyze the performance of model deployments over time using standard statistical
    measures and exportable visualizations. Use this tool to determine whether a model's
    quality is decaying and if you should consider replacing it.
  name: observability_accuracy
- description: Use the endpoints described below to manage batch monitoring. You can
    view monitoring statistics organized by batch, instead of by time, with batch-enabled
    deployments. To do this, you can create batches, add predictions to those batches,
    and view service health, data drift, and accuracy statistics for the batches in
    your deployment.
  name: observability_batch_monitoring
- description: Use the endpoints described below to manage Bias and Fairness.  Bias
    and Fairness testing provides methods to calculate fairness for a binary classification
    model and attempt to identify any biases in the model's predictive behavior. In
    DataRobot, bias represents the difference between a model's predictions for different
    populations (or groups) while fairness is the measure of the model's bias. Select
    protected features in the dataset and choose fairness metrics and mitigation techniques
    either [before model building](fairness-metrics#configure-metrics-and-mitigation-pre-autopilot)
    or [from the Leaderboard](fairness-metrics#configure-metrics-and-mitigation-post-autopilot)
    once models are built. [Bias and Fairness insights](bias/index) help identify
    bias in a model and visualize the root-cause analysis, explaining why the model
    is learning bias from the training data and from where.
  name: observability_bias_fairness
- description: Use the endpoints described below to manage deployment configuration.
    Configure capabilities of your current deployment based on the data provided,
    for example, training data, prediction data, or actuals. After you create and
    configure a deployment, you can use the deployment settings to add or update deployment
    functionality that wasn't configured during deployment creation.
  name: observability_configuration
- description: Use the endpoints described below to manage custom metrics. Use the
    data you collect from data exploration (or data calculated through other custom
    metrics) to compute and monitor custom business or performance metrics. This feature
    allows you to implement your organization's specialized metrics, expanding on
    the insights provided by DataRobot's built-in service health, data drift, and
    accuracy metrics.
  name: observability_custom_metrics
- description: Use the endpoints described below to manage data exploration. Use the
    data you collect from data exploration tab (or data calculated through other custom
    metrics) to compute and monitor custom business or performance metrics. This feature
    allows you to implement your organization's specialized metrics, expanding on
    the insights provided by DataRobot's built-in service health, data drift, and
    accuracy metrics.
  name: observability_data_exploration
- description: Use the endpoints described below to manage drift. When deploying a
    model, there is a chance that the dataset used for training and validation differs
    from the prediction data. DataRobot monitors both target and feature drift information.
  name: observability_drift
- description: Use the endpoints described below to manage service health. Service
    health tracks metrics about a deployment's ability to respond to prediction requests
    quickly and reliably. This helps identify bottlenecks and assess capacity, which
    is critical to proper provisioning.
  name: observability_service_health
- description: Endpoints associated with running OCR on Datasets.  Actions include
    starting an OCR job on a dataset, getting the job's status and getting error reports
    from the job.
  name: ocr_service
- description: Use the endpoints described below to manage predictions.
  name: predictions
- description: Use the endpoints described below to manage predictions information.
  name: predictions_info
- description: Use the endpoints described below to manage projects and their properties.
  name: projects
- description: Use the endpoints described below to manage resource quotas. Quotas
    provide limits on resource consumption for deployments, models, and other DataRobot
    resources to ensure fair usage and prevent resource exhaustion.
  name: quotas
- description: Use the endpoints described below to manage retraining. To maintain
    model performance after deployment without extensive manual work, DataRobot provides
    an automatic retraining capability for deployments. Upon providing a retraining
    dataset registered in the Data Registry, you can define up to five retraining
    policies on each deployment. Each policy consists of a trigger, a modeling strategy,
    modeling settings, and a replacement action. When triggered, retraining will produce
    a new model based on these settings and notify you to consider promoting it.
  name: retraining
- description: Use the endpoints described below to manage 'Risk Management' entities.
  name: risk_management
- description: Manage seat licenses using the endpoints described below.
  name: seat_licenses
- 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: Use the endpoints described below to manage service health. Service
    health tracks metrics about a deployment's ability to respond to prediction requests
    quickly and reliably. This helps identify bottlenecks and assess capacity, which
    is critical to proper provisioning.
  name: service_health
- 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: 'Use the endpoints described below to manage tracking agent. When you
    enable the monitoring agent feature, you have access to the agent installation
    and MLOps components, all packaged within a single tarball. '
  name: tracking_agent
- 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: This page describes the endpoints for handling users, groups, and organizations.
  name: user_management
- description: Use the endpoints described below to configure and manage encrypted
    credentials.
  name: utilities
- description: Use the endpoints described below to manage Value Trackers, as well
    as add comments and host discussions.
  name: value_tracker
- description: OAuth Providers Service API enables management of external OAuth providers
    allowing DataRobot users to connect their workflows with external provider resources.
  name: OAuth Providers
