swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ModelV1Dot1Preview3 API
  description: Manages reinforcement learning configuration operations.
schemes:
- https
tags:
- name: ModelV1Dot1Preview3
  description: Manages reinforcement learning configuration operations.
paths:
  /model:
    get:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Get Model
      description: Get the model file generated by Personalizer service.
      operationId: microsoftAzureModelGet
      consumes: []
      produces:
      - application/octet-stream
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      - in: query
        name: signed
        description: True if requesting signed model zip archive, false otherwise.
        type: boolean
        default: false
      responses:
        '200':
          description: Success
          schema:
            type: file
        default:
          description: Requested resource does not exist 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 Model_Get request:
          $ref: ./examples/Model_Get.json
    put:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Put The Digitally Signed Model File
      description: Replace the existing model file for the Personalizer service.
      operationId: microsoftAzureModelImport
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      - in: body
        name: body
        description: The digitally signed model file obtained from getting the model.
        required: true
        schema:
          format: binary
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Given model file is not signed or does not have a valid signature.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Model_Import request:
          $ref: ./examples/Model_Import.json
    delete:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Reset Model
      description: Resets the model file generated by Personalizer service.
      operationId: microsoftAzureModelReset
      consumes: []
      produces:
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      responses:
        '204':
          description: No Content
        default:
          description: Model reset failed.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Model_Reset request:
          $ref: ./examples/Model_Reset.json
  /model/properties:
    get:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Get Model Properties
      description: Get properties of the model file generated by Personalizer service.
      operationId: microsoftAzureModelGetproperties
      consumes: []
      produces:
      - application/json
      parameters:
      - name: api-version
        in: query
        required: true
        type: string
        description: Client API version.
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ModelProperties'
        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 Model_GetProperties request:
          $ref: ./examples/Model_GetProperties.json
definitions:
  ErrorResponse:
    description: Used to return an error to the client
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PersonalizerError'
  ModelProperties:
    description: Properties related to the trained model.
    type: object
    properties:
      creationTime:
        format: date-time
        description: Creation time of the model.
        type: string
        readOnly: true
      lastModifiedTime:
        format: date-time
        description: Last time the model was modified.
        type: string
        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: '#/definitions/PersonalizerError'
        readOnly: true
      innerError:
        $ref: '#/definitions/InternalError'
  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'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'