Microsoft Azure FeatureImportances20220901Preview API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Feature Importances20220901 Preview API
  description: Manages feature importance operations.
tags:
- name: FeatureImportances20220901Preview
  description: Manages feature importance operations.
paths:
  /featureImportances/{featureImportanceId}:
    delete:
      tags:
      - FeatureImportances20220901Preview
      summary: Microsoft Azure Delete Feature Importance
      description: Delete the Feature Importance associated with the Id.
      operationId: microsoftAzureFeatureimportancesDelete
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      - in: path
        name: featureImportanceId
        description: Id of the Feature Importance to delete.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '204':
          description: No Content
        default:
          description: A generic error has occurred on the server.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful FeatureImportances_Delete request:
          $ref: ./examples/FeatureImportances_Delete.json
    get:
      tags:
      - FeatureImportances20220901Preview
      summary: Microsoft Azure Get Feature Importance
      description: Get the Feature Importance associated with the Id.
      operationId: microsoftAzureFeatureimportancesGet
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      - in: path
        name: featureImportanceId
        description: Id of the Feature Importance.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureImportance'
        default:
          description: Feature importance not found.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful FeatureImportances_Get request:
          $ref: ./examples/FeatureImportances_Get.json
    put:
      tags:
      - FeatureImportances20220901Preview
      summary: Microsoft Azure Create Feature Importance
      description: Submit a new Feature Importance job.
      operationId: microsoftAzureFeatureimportancesCreate
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      - in: path
        name: featureImportanceId
        description: Id of the Feature Importance to create.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '200':
          description: Success
        default:
          description: Invalid contract.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful FeatureImportances_Create request:
          $ref: ./examples/FeatureImportances_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureImportanceContract'
        description: The Feature Importance job definition.
        required: true
  /featureImportances:
    get:
      tags:
      - FeatureImportances20220901Preview
      summary: Microsoft Azure List Feature Importances
      description: List of all Feature Importances.
      operationId: microsoftAzureFeatureimportancesList
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      - in: query
        name: top
        description: The maximum number of resources to return from the collection. Defaults to maximum value of integer.
        schema:
          type: integer
          format: int32
      - in: query
        name: skip
        description: An offset into the collection of the first resource to be returned. Defaults to 0.
        schema:
          type: integer
          format: int32
          default: 0
      - in: query
        name: maxpagesize
        description: The maximum number of resources to include in a single response. Defaults to 100.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureImportances'
        default:
          description: A generic error has occurred on the server.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful FeatureImportances_List request:
          $ref: ./examples/FeatureImportances_List.json
components:
  schemas:
    ErrorResponse:
      description: Used to return an error to the client
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PersonalizerError'
    FeatureScore:
      type: object
      properties:
        namespace:
          description: Feature namespace
          type: string
          readOnly: true
        featureName:
          description: Feature name
          type: string
        score:
          format: float
          description: Feature score
          type: number
          readOnly: true
    PersonalizerError:
      description: The error object.
      required:
      - code
      - message
      type: object
      properties:
        code:
          description: Error Codes returned by Personalizer
          enum:
          - BadRequest
          - InvalidServiceConfiguration
          - InvalidLearningModeServiceConfiguration
          - InvalidPolicyConfiguration
          - InvalidPolicyContract
          - InvalidEvaluationContract
          - InvalidContract
          - DuplicateCustomPolicyNames
          - NoLogsExistInDateRange
          - LogsSizeExceedAllowedLimit
          - InvalidRewardRequest
          - InvalidEventIdToActivate
          - InvalidRankRequest
          - InvalidExportLogsRequest
          - InvalidRequest
          - InvalidSasUri
          - InvalidModelMetadata
          - ApprenticeModeNeverTurnedOn
          - MissingAppId
          - InvalidRewardWaitTime
          - InvalidLogRetentionDays
          - InvalidMultiSlotApiAccess
          - PayloadSizeExceeded
          - InvalidModelImportSignature
          - InvalidModelImportFormat
          - FeatureImportanceAlreadyExists
          - EvaluationAlreadyExists
          - InvalidModelRetrainDays
          - InvalidApiAccess
          - ModelFileAccessDenied
          - ProblemTypeIncompatibleWithAutoOptimization
          - ResourceNotFound
          - FrontEndNotFound
          - EvaluationNotFound
          - FeatureImportanceNotFound
          - LearningSettingsNotFound
          - EvaluationModelNotFound
          - LogsPropertiesNotFound
          - RequestTimeout
          - ModelRankingError
          - InternalServerError
          - ModelDownloadFailed
          - RankNullResponse
          - UpdateConfigurationFailed
          - InferenceModelUpdateFailed
          - ModelResetFailed
          - ModelPublishFailed
          - ModelMetadataUpdateFailed
          - EvaluationsGetListFailed
          - OperationNotAllowed
          type: string
          x-ms-enum:
            name: PersonalizerErrorCode
            modelAsString: true
            values:
            - value: BadRequest
              description: Request could not be understood by the server.
            - value: InvalidServiceConfiguration
              description: Invalid service configuration.
            - value: InvalidLearningModeServiceConfiguration
              description: Updating defaultReward, rewardWaitTime and rewardAggregation when changing learning mode from Online to Apprentice mode and vice versa is not allowed. Make the mode change and then change the additional settings with an additional API call.
            - value: InvalidPolicyConfiguration
              description: Invalid policy configuration.
            - value: InvalidPolicyContract
              description: Invalid policy contract.
            - value: InvalidEvaluationContract
              description: Invalid evaluation contract.
            - value: InvalidContract
              description: Invalid contract.
            - value: DuplicateCustomPolicyNames
              description: Custom policy names should be unique.
            - value: NoLogsExistInDateRange
              description: No logs exist in date range.
            - value: LogsSizeExceedAllowedLimit
              description: Total size of logs exceed allowed limit.
            - value: InvalidRewardRequest
              description: Invalid reward request.
            - value: InvalidEventIdToActivate
              description: Invalid activate event request.
            - value: InvalidRankRequest
              description: Invalid request.
            - value: InvalidExportLogsRequest
              description: Invalid request.
            - value: InvalidRequest
              description: Invalid request.
            - value: InvalidSasUri
              description: SAS Uri must be the Uri to a container that has write permissions; Or the date in SAS Uri is not in the format of yyyy-mm-ddThh:mm:ssZ.
            - value: InvalidModelMetadata
              description: Invalid model metadata.
            - value: ApprenticeModeNeverTurnedOn
              description: Apprentice mode never turned on.
            - value: MissingAppId
              description: AppId is missing in the header.
            - value: InvalidRewardWaitTime
              description: Reward wait time should be either 10 minutes or 4 hours or 12 hours or 24 hours
            - value: InvalidLogRetentionDays
              description: Log Retention Days must be -1 to store indefinitely or must be at least reward wait time plus 1 day (rounded up)
            - value: InvalidMultiSlotApiAccess
              description: Multi-slot feature is currently disabled. Please follow multi-slot Personalizer documentation to update your loop settings to enable multi-slot functionality.
            - value: PayloadSizeExceeded
              description: Exceeds maximum allowed payload size.
            - value: InvalidModelImportSignature
              description: Given model file is not signed or does not have a valid signature.
            - value: InvalidModelImportFormat
              description: Given model file format is invalid.
            - value: FeatureImportanceAlreadyExists
              description: Feature importance with id {0} already exists.
            - value: EvaluationAlreadyExists
              description: Evaluation with id {0} already exists.
            - value: InvalidModelRetrainDays
              description: Model retrain days must be between 0 and the number of log retention days.
            - value: InvalidApiAccess
              description: Api is currently disabled for the instance.
            - value: ModelFileAccessDenied
              description: Key vault Key used for customer managed key cannot be accessed.
            - value: ProblemTypeIncompatibleWithAutoOptimization
              description: Auto-optimization is not compatible with multi-slot personalization.
            - value: ResourceNotFound
              description: Requested resource does not exist on the server.
            - value: FrontEndNotFound
              description: Front end not found.
            - value: EvaluationNotFound
              description: Offline Evaluation not found.
            - value: FeatureImportanceNotFound
              description: Feature importance not found.
            - value: LearningSettingsNotFound
              description: Learning Settings not found in evaluation.
            - value: EvaluationModelNotFound
              description: Model not found in evaluation.
            - value: LogsPropertiesNotFound
              description: Log properties not found.
            - value: RequestTimeout
              description: The task was canceled.
            - value: ModelRankingError
              description: Error while ranking actions using model. Please verify the learning settings are valid.
            - value: InternalServerError
              description: A generic error has occurred on the server.
            - value: ModelDownloadFailed
              description: Failed to download model.
            - value: RankNullResponse
              description: Rank call returned null response.
            - value: UpdateConfigurationFailed
              description: Failed to update configuration.
            - value: InferenceModelUpdateFailed
              description: Failed to update inference model.
            - value: ModelResetFailed
              description: Model reset failed.
            - value: ModelPublishFailed
              description: Model publish failed.
            - value: ModelMetadataUpdateFailed
              description: Model metadata update failed.
            - value: EvaluationsGetListFailed
              description: Failed to get evaluations list.
            - value: OperationNotAllowed
              description: This operation is not allowed at this time.
        message:
          description: A message explaining the error reported by the service.
          type: string
        target:
          description: Error source element.
          type: string
          readOnly: true
        details:
          description: An array of details about specific errors that led to this reported error.
          type: array
          items:
            $ref: '#/components/schemas/PersonalizerError'
          readOnly: true
        innerError:
          $ref: '#/components/schemas/InternalError'
    FeatureImportance:
      type: object
      properties:
        id:
          description: The ID of the feature importance.
          maxLength: 256
          type: string
          readOnly: true
        name:
          description: The name of the feature importance.
          maxLength: 256
          type: string
          readOnly: true
        startTime:
          format: date-time
          description: The start time of the feature importance.
          type: string
          readOnly: true
        endTime:
          format: date-time
          description: The end time of the feature importance.
          type: string
          readOnly: true
        creationTime:
          format: date-time
          description: The creation time of the feature importance.
          type: string
          readOnly: true
        status:
          description: The status of the job processing the feature importance.
          enum:
          - Succeeded
          - Running
          - Failed
          - NotSubmitted
          - Timeout
          - Canceled
          type: string
          readOnly: true
          x-ms-enum:
            name: FeatureImportanceStatus
            modelAsString: true
        featureScores:
          description: Array of normalized feature scores sorted in descending order.
          type: array
          items:
            $ref: '#/components/schemas/FeatureScore'
          readOnly: true
        description:
          description: Description of the feature importance job.
          type: string
          readOnly: true
    InternalError:
      description: An object containing more specific information than the parent object about the error.
      type: object
      properties:
        code:
          description: Detailed error code.
          type: string
        innererror:
          $ref: '#/components/schemas/InternalError'
    FeatureImportanceContract:
      required:
      - endTime
      - name
      - startTime
      type: object
      properties:
        name:
          description: The name of the feature importance.
          maxLength: 256
          type: string
        startTime:
          format: date-time
          description: The start time of the feature importance.
          type: string
        endTime:
          format: date-time
          description: The end time of the feature importance.
          type: string
    FeatureImportances:
      description: FeatureImportances
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/FeatureImportanceDetails'
        nextLink:
          type: string
    FeatureImportanceDetails:
      type: object
      properties:
        id:
          maxLength: 256
          type: string
          readOnly: true
        name:
          maxLength: 256
          type: string
          readOnly: true
        startTime:
          format: date-time
          type: string
          readOnly: true
        endTime:
          format: date-time
          type: string
          readOnly: true
        creationTime:
          format: date-time
          type: string
          readOnly: true
        status:
          description: The status of the feature importance job.
          enum:
          - Succeeded
          - Running
          - Failed
          - NotSubmitted
          - Timeout
          - Canceled
          type: string
          readOnly: true
          x-ms-enum:
            name: FeatureImportanceStatus
            modelAsString: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'