Microsoft Azure Evaluations20220901Preview API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Evaluations20220901Preview API
  description: Manages evaluations operations.
schemes:
- https
tags:
- name: Evaluations20220901Preview
  description: Manages evaluations operations.
paths:
  /evaluations/{evaluationId}:
    get:
      tags:
      - Evaluations20220901Preview
      summary: Microsoft Azure Get Evaluation
      description: Get the Offline Evaluation associated with the Id.
      operationId: microsoftAzureEvaluationsGet
      consumes: []
      produces:
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      - name: evaluationId
        in: path
        description: Id of the Offline Evaluation.
        required: true
        type: string
        maxLength: 256
      - in: query
        name: intervalInMinutes
        description: '"Time interval for aggregation of events in minutes. Allowed intervals: 5 minutes, 60 minutes, 360 minutes, 720 minutes and 1440 minutes. Defaults to 5 minutes.'
        type: integer
        format: int32
      - in: query
        name: startTime
        description: Start of aggregation time interval.
        type: string
        format: date-time
        required: true
      - in: query
        name: endTime
        description: End of aggregation time interval.
        type: string
        format: date-time
        required: true
      - in: query
        name: window
        description: Rolling or Expanding time. Rolling compatible with 60 minutes, 360 minutes, 720 minutes and 1440 minutes intervals. Expanding compatible with 5 minute time interval only. Defaults to Expanding.
        type: string
        enum:
        - Expanding
        - Rolling
        x-ms-enum:
          name: Window
          modelAsString: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Evaluation'
        default:
          description: Offline Evaluation not found.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Evaluations_Get request:
          $ref: ./examples/Evaluations_Get.json
    delete:
      tags:
      - Evaluations20220901Preview
      summary: Microsoft Azure Delete Evaluation
      description: Delete the Offline Evaluation associated with the Id.
      operationId: microsoftAzureEvaluationsDelete
      consumes: []
      produces: []
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      - name: evaluationId
        in: path
        description: Id of the Offline Evaluation to delete.
        required: true
        type: string
        maxLength: 256
      responses:
        '204':
          description: No Content
        default:
          description: Offline Evaluation not found.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Evaluations_Delete request:
          $ref: ./examples/Evaluations_Delete.json
    put:
      tags:
      - Evaluations20220901Preview
      summary: Microsoft Azure Create Offline Evaluation
      description: Submit a new Offline Evaluation job.
      operationId: microsoftAzureEvaluationsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      - in: path
        name: evaluationId
        description: Id of the Offline Evaluation to create.
        required: true
        type: string
        maxLength: 256
      - in: body
        name: evaluation
        description: The Offline Evaluation job definition.
        required: true
        schema:
          $ref: '#/definitions/EvaluationContract'
      responses:
        '200':
          description: Success
        default:
          description: Invalid contract.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Evaluations_Create request:
          $ref: ./examples/Evaluations_Create.json
  /evaluations:
    get:
      tags:
      - Evaluations20220901Preview
      summary: Microsoft Azure List Offline Evaluations
      description: List of all Offline Evaluations.
      operationId: microsoftAzureEvaluationsList
      produces:
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      - in: query
        name: filter
        description: "An expression to filter the evaluations against evaluation metadata. Only evaluations where the expression evaluates to true are included in the response.\r\nHere is an example, metadata=evaluationType eq 'Manual'."
        type: string
      - in: query
        name: top
        description: The maximum number of resources to return from the collection. Defaults to maximum value of integer.
        type: integer
        format: int32
      - in: query
        name: skip
        description: An offset into the collection of the first resource to be returned. Defaults to 0.
        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.
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Evaluations'
        default:
          description: A generic error has occurred on the server.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Evaluations_List request:
          $ref: ./examples/Evaluations_List.json
definitions:
  PolicyContract:
    description: Learning settings specifying how to train the model.
    required:
    - arguments
    - name
    type: object
    properties:
      name:
        description: Name of the learning settings.
        maxLength: 256
        type: string
      arguments:
        description: Arguments of the learning settings.
        maxLength: 1024
        type: string
  ErrorResponse:
    description: Used to return an error to the client
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PersonalizerError'
  EvaluationResult:
    type: object
    properties:
      startTime:
        format: date-time
        description: Start time of the time series.
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: End time of the time series.
        type: string
        readOnly: true
      intervalInMinutes:
        format: int32
        description: Aggregation window.
        type: integer
        readOnly: true
      value:
        description: Time series of the learning settings results.
        type: array
        items:
          $ref: '#/definitions/PolicyResult'
  PolicyResult:
    type: object
    properties:
      name:
        description: The name of the Learning Settings.
        type: string
        readOnly: true
      slotId:
        description: Slot id. Empty for overall results and single slot results.
        type: string
        readOnly: true
      arguments:
        description: The arguments of the Learning Settings.
        type: string
        readOnly: true
      policySource:
        description: The source of the Learning Settings.
        enum:
        - Online
        - Baseline
        - Random
        - Custom
        - OfflineExperimentation
        type: string
        readOnly: true
        x-ms-enum:
          name: PolicySource
          modelAsString: true
      summary:
        $ref: '#/definitions/Summary'
        readOnly: true
      timeseries:
        $ref: '#/definitions/TimeSeries'
        readOnly: true
  EvaluationDetails:
    type: object
    properties:
      id:
        description: The ID of the evaluation.
        maxLength: 256
        type: string
        readOnly: true
      name:
        description: The name of the evaluation.
        maxLength: 256
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: The start time of the evaluation.
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: The end time of the evaluation.
        type: string
        readOnly: true
      creationTime:
        format: date-time
        description: The creation time of the evaluation.
        type: string
        readOnly: true
      status:
        description: The status of the job processing the evaluation.
        enum:
        - Succeeded
        - Running
        - Failed
        - NotSubmitted
        - Timeout
        - OptimalPolicyApplied
        - OnlinePolicyRetained
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: EvaluationJobStatus
          modelAsString: true
      evaluationType:
        description: Type of evaluation.
        enum:
        - Manual
        - Auto
        type: string
        readOnly: true
        x-ms-enum:
          name: EvaluationType
          modelAsString: true
  Data:
    type: object
    properties:
      timeStamp:
        format: date-time
        description: Timestamp of the aggregation.
        type: string
        readOnly: true
      expectedReward:
        format: float
        description: Average reward.
        type: number
        readOnly: true
      confidenceInterval:
        description: Confidence interval.
        type: array
        items:
          format: float
          type: number
        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: '#/definitions/InternalError'
  EvaluationContract:
    description: A counterfactual evaluation.
    required:
    - endTime
    - name
    - policies
    - startTime
    type: object
    properties:
      enablePolicyOptimization:
        description: True if the evaluation should explore for a more optimal learning settings.
        type: boolean
      name:
        description: The name of the evaluation.
        maxLength: 256
        type: string
      startTime:
        format: date-time
        description: The start time of the evaluation.
        type: string
      endTime:
        format: date-time
        description: The end time of the evaluation.
        type: string
      policies:
        description: Additional learning settings to evaluate.
        type: array
        items:
          $ref: '#/definitions/PolicyContract'
  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: '#/definitions/PersonalizerError'
        readOnly: true
      innerError:
        $ref: '#/definitions/InternalError'
  Evaluation:
    description: A counterfactual evaluation.
    type: object
    properties:
      id:
        description: The ID of the evaluation.
        maxLength: 256
        type: string
        readOnly: true
      name:
        description: The name of the evaluation.
        maxLength: 256
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: The start time of the evaluation.
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: The end time of the evaluation.
        type: string
        readOnly: true
      creationTime:
        format: date-time
        description: The creation time of the evaluation.
        type: string
        readOnly: true
      status:
        description: The status of the job processing the evaluation.
        enum:
        - Succeeded
        - Running
        - Failed
        - NotSubmitted
        - Timeout
        - OptimalPolicyApplied
        - OnlinePolicyRetained
        - Canceled
        type: string
        readOnly: true
        x-ms-enum:
          name: EvaluationJobStatus
          modelAsString: true
      evaluationType:
        description: The type of evaluation.
        enum:
        - Manual
        - Auto
        type: string
        readOnly: true
        x-ms-enum:
          name: EvaluationType
          modelAsString: true
      optimalPolicy:
        description: Optimal policy found by the evaluation job.
        type: string
        readOnly: true
      content:
        $ref: '#/definitions/EvaluationResult'
      description:
        description: Description of the evaluation job.
        type: string
        readOnly: true
  Evaluations:
    description: Evaluations
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/EvaluationDetails'
      nextLink:
        type: string
  Summary:
    type: object
    properties:
      expectedReward:
        format: float
        description: Average reward.
        type: number
        readOnly: true
      confidenceInterval:
        description: Confidence interval.
        type: array
        items:
          format: float
          type: number
        readOnly: true
  TimeSeries:
    type: object
    properties:
      data:
        description: Time series.
        type: array
        items:
          $ref: '#/definitions/Data'
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'