Microsoft Azure EvaluationsV1Dot1Preview1 API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Evaluations V1 Dot1 Preview1 API
  description: Manages counterfactual evaluation operations.
tags:
- name: EvaluationsV1Dot1Preview1
  description: Manages counterfactual evaluation operations.
paths:
  /evaluations/{evaluationId}:
    get:
      tags:
      - EvaluationsV1Dot1Preview1
      summary: Microsoft Azure Get Evaluation
      description: Get the Offline Evaluation associated with the Id.
      operationId: microsoftAzureEvaluationsGet
      parameters:
      - name: evaluationId
        in: path
        description: Id of the Offline Evaluation.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Evaluation'
        default:
          description: Offline Evaluation not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful Evaluations_Get request:
          $ref: ./examples/Evaluations_Get.json
    delete:
      tags:
      - EvaluationsV1Dot1Preview1
      summary: Microsoft Azure Delete Evaluation
      description: Delete the Offline Evaluation associated with the Id.
      operationId: microsoftAzureEvaluationsDelete
      parameters:
      - name: evaluationId
        in: path
        description: Id of the Offline Evaluation to delete.
        required: true
        schema:
          type: string
          maxLength: 256
      responses:
        '204':
          description: Success
      x-ms-examples:
        Successful Evaluations_Delete request:
          $ref: ./examples/Evaluations_Delete.json
  /evaluations:
    get:
      tags:
      - EvaluationsV1Dot1Preview1
      summary: Microsoft Azure List Offline Evaluations
      description: List of all Offline Evaluations.
      operationId: microsoftAzureEvaluationsList
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Evaluation'
      x-ms-examples:
        Successful Evaluations_List request:
          $ref: ./examples/Evaluations_List.json
    post:
      tags:
      - EvaluationsV1Dot1Preview1
      summary: Microsoft Azure Create Offline Evaluation
      description: Submit a new Offline Evaluation job.
      operationId: microsoftAzureEvaluationsCreate
      responses:
        '201':
          description: Success
          headers:
            Location:
              description: Location of the Offline Evaluation status and data.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Evaluation'
        default:
          description: Invalid evaluation contract.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful Evaluations_Create request:
          $ref: ./examples/Evaluations_Create.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluationContract'
        description: The Offline Evaluation job definition.
        required: true
components:
  schemas:
    ErrorResponse:
      description: Used to return an error to the client
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PersonalizerError'
    PolicyResult:
      description: This class contains the Learning Settings information and the results of the Offline Evaluation using that policy.
      type: object
      properties:
        name:
          description: The name of the Learning Settings.
          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:
          description: The aggregate results of the Offline Evaluation.
          type: array
          items:
            $ref: '#/components/schemas/PolicyResultSummary'
          readOnly: true
        totalSummary:
          description: The aggregate total of the Offline Evaluation.
          type: object
          allOf:
          - $ref: '#/components/schemas/PolicyResultSummary'
          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
          - DuplicateCustomPolicyNames
          - NoLogsExistInDateRange
          - LogsSizeExceedAllowedLimit
          - InvalidRewardRequest
          - InvalidEventIdToActivate
          - InvalidRankRequest
          - InvalidExportLogsRequest
          - InvalidRequest
          - InvalidContainer
          - InvalidModelMetadata
          - ApprenticeModeNeverTurnedOn
          - MissingAppId
          - InvalidRewardWaitTime
          - InvalidMultiSlotApiAccess
          - ModelFileAccessDenied
          - ProblemTypeIncompatibleWithAutoOptimization
          - ResourceNotFound
          - FrontEndNotFound
          - EvaluationNotFound
          - LearningSettingsNotFound
          - EvaluationModelNotFound
          - LogsPropertiesNotFound
          - ModelRankingError
          - InternalServerError
          - RankNullResponse
          - UpdateConfigurationFailed
          - ModelResetFailed
          - ModelPublishFailed
          - ModelMetadataUpdateFailed
          - 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: 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: InvalidContainer
              description: SAS Uri must be the Uri to a container that has write permissions.
            - 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 between 5 seconds and 2 days
            - 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: 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: LearningSettingsNotFound
              description: Learning Settings not found in evaluation.
            - value: EvaluationModelNotFound
              description: Model not found in evaluation.
            - value: LogsPropertiesNotFound
              description: Log properties not found.
            - 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: RankNullResponse
              description: Rank call returned null response.
            - value: UpdateConfigurationFailed
              description: Failed to update configuration.
            - value: ModelResetFailed
              description: Model reset failed.
            - value: ModelPublishFailed
              description: Model publish failed.
            - value: ModelMetadataUpdateFailed
              description: Model metadata update failed.
            - 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
        details:
          description: An array of details about specific errors that led to this reported error.
          type: array
          items:
            $ref: '#/components/schemas/PersonalizerError'
        innerError:
          $ref: '#/components/schemas/InternalError'
    PolicyResultSummary:
      description: This class contains the summary of evaluating a policy on a counterfactual evaluation.
      type: object
      properties:
        timeStamp:
          format: date-time
          description: Timestamp of the aggregation.
          type: string
          readOnly: true
        ipsEstimatorNumerator:
          format: float
          description: Numerator for IPS estimator.
          type: number
          readOnly: true
        ipsEstimatorDenominator:
          format: float
          description: Denominator for IPS estimator.
          type: number
          readOnly: true
        snipsEstimatorDenominator:
          format: float
          description: Denominator for SNIPS estimator.
          type: number
          readOnly: true
        aggregateTimeWindow:
          format: duration
          description: 'Time window for aggregation.

            For example, PT5M (5 mins). For information about the time format,

            see http://en.wikipedia.org/wiki/ISO_8601#Durations'
          type: string
          readOnly: true
        nonZeroProbability:
          format: float
          description: Probability of non-zero values for the Policy evaluation.
          type: number
        sumOfSquares:
          format: float
          description: Sum of Squares for the Policy evaluation results.
          type: number
          readOnly: true
        confidenceInterval:
          format: float
          description: Gaussian confidence interval for the Policy evaluation.
          type: number
          readOnly: true
        averageReward:
          format: float
          description: Average reward.
          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: '#/components/schemas/InternalError'
    PolicyContract:
      description: Learning settings specifying how to train the model.
      required:
      - name
      - arguments
      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
    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
        jobId:
          description: The ID of the job processing the evaluation.
          type: string
          readOnly: true
        status:
          description: The status of the job processing the evaluation.
          enum:
          - completed
          - pending
          - failed
          - notSubmitted
          - timeout
          - optimalPolicyApplied
          - onlinePolicyRetained
          type: string
          readOnly: true
          x-ms-enum:
            name: EvaluationJobStatus
            modelAsString: true
        policyResults:
          description: The results of the evaluation.
          type: array
          items:
            $ref: '#/components/schemas/PolicyResult'
        featureImportance:
          description: Feature Importance.
          type: array
          items:
            type: array
            items:
              type: string
        evaluationType:
          description: Evaluation type (manual or through Automatic Optimization).
          enum:
          - Manual
          - Auto
          type: string
          x-ms-enum:
            name: EvaluationType
            modelAsString: true
        optimalPolicy:
          description: Thr optimal policy.
          type: string
        creationTime:
          description: Creation time.
          format: date-time
          type: string
    EvaluationContract:
      description: A counterfactual evaluation.
      required:
      - name
      - startTime
      - endTime
      - policies
      type: object
      properties:
        enableOfflineExperimentation:
          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: '#/components/schemas/PolicyContract'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'