Microsoft Azure ConfigurationsV1Dot1Preview1 API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ConfigurationsV1Dot1Preview1 API
  description: Manages configuration operations.
schemes:
- https
tags:
- name: ConfigurationsV1Dot1Preview1
  description: Manages configuration operations.
paths:
  /configurations/service:
    get:
      tags:
      - ConfigurationsV1Dot1Preview1
      summary: Microsoft Azure Get Service Configuration
      description: Get the Personalizer service configuration.
      operationId: microsoftAzureServiceconfigurationGet
      consumes: []
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ServiceConfiguration'
      x-ms-examples:
        Successful ServiceConfiguration_Get request:
          $ref: ./examples/ServiceConfiguration_Get.json
    put:
      tags:
      - ConfigurationsV1Dot1Preview1
      summary: Microsoft Azure Update Service Configuration
      description: Update the Personalizer service configuration.
      operationId: microsoftAzureServiceconfigurationUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: config
        in: body
        description: The personalizer service configuration.
        required: true
        schema:
          $ref: '#/definitions/ServiceConfiguration'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ServiceConfiguration'
        default:
          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.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful ServiceConfiguration_Update request:
          $ref: ./examples/ServiceConfiguration_Update.json
  /configurations/policy:
    get:
      tags:
      - ConfigurationsV1Dot1Preview1
      summary: Microsoft Azure Get Policy
      description: Get the Learning Settings currently used by the Personalizer service.
      operationId: microsoftAzurePolicyGet
      consumes: []
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PolicyContract'
      x-ms-examples:
        Successful Policy_Get request:
          $ref: ./examples/Policy_Get.json
    put:
      tags:
      - ConfigurationsV1Dot1Preview1
      summary: Microsoft Azure Update Policy
      description: Update the Learning Settings that the Personalizer service will use to train models.
      operationId: microsoftAzurePolicyUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: policy
        in: body
        description: The learning settings.
        required: true
        schema:
          $ref: '#/definitions/PolicyContract'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PolicyContract'
        default:
          description: Invalid policy configuration.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Policy_Update request:
          $ref: ./examples/Policy_Update.json
    delete:
      tags:
      - ConfigurationsV1Dot1Preview1
      summary: Microsoft Azure Reset Policy
      description: Resets the learning settings of the Personalizer service to default.
      operationId: microsoftAzurePolicyReset
      consumes: []
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PolicyContract'
      x-ms-examples:
        Successful Policy_Reset request:
          $ref: ./examples/Policy_Reset.json
  /configurations/applyFromEvaluation:
    post:
      tags:
      - ConfigurationsV1Dot1Preview1
      summary: Microsoft Azure Apply Learning Settings And Model From A Pre Existing Offline Evaluation, Making Them The Current Online Learning Settings And Model And Replacing The Previous Ones
      operationId: microsoftAzureServiceconfigurationApplyfromevaluation
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Reference to the policy within the evaluation.
        required: true
        schema:
          $ref: '#/definitions/PolicyReferenceContract'
      responses:
        '204':
          description: Success
        default:
          description: Learning Settings not found in evaluation.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful ServiceConfiguration_ApplyFromEvaluation request:
          $ref: ./examples/ServiceConfiguration_ApplyFromEvaluation.json
      description: Needs a more full description created.
definitions:
  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
  ErrorResponse:
    description: Used to return an error to the client
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PersonalizerError'
  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'
  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: '#/definitions/PersonalizerError'
      innerError:
        $ref: '#/definitions/InternalError'
  ServiceConfiguration:
    description: The configuration of the service.
    required:
    - rewardWaitTime
    - defaultReward
    - rewardAggregation
    - explorationPercentage
    - modelExportFrequency
    - logRetentionDays
    type: object
    properties:
      rewardWaitTime:
        format: duration
        description: "The time span waited until a request is marked with the default reward\r\nand should be between 5 seconds and 2 days.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations"
        type: string
      defaultReward:
        format: float
        description: The reward given if a reward is not received within the specified wait time.
        maximum: 1
        minimum: -1
        type: number
      rewardAggregation:
        description: The function used to process rewards, if multiple reward scores are received before rewardWaitTime is over.
        maxLength: 256
        type: string
      explorationPercentage:
        format: float
        description: The percentage of rank responses that will use exploration.
        maximum: 1
        minimum: 0
        type: number
      modelExportFrequency:
        format: duration
        description: "Personalizer will start using the most updated trained model for online ranks automatically every specified time period.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations"
        type: string
      logMirrorEnabled:
        description: Flag indicates whether log mirroring is enabled.
        type: boolean
      logMirrorSasUri:
        description: Azure storage account container SAS URI for log mirroring.
        type: string
      logRetentionDays:
        format: int32
        description: Number of days historical logs are to be maintained. -1 implies the logs will never be deleted.
        maximum: 2147483647
        minimum: -1
        type: integer
      lastConfigurationEditDate:
        format: date-time
        description: Last time model training configuration was updated
        type: string
      learningMode:
        description: Learning Modes for Personalizer
        enum:
        - Online
        - Apprentice
        - LoggingOnly
        type: string
        x-ms-enum:
          name: LearningMode
          modelAsString: true
      isAutoOptimizationEnabled:
        description: Flag indicating whether Personalizer will automatically optimize Learning Settings by running Offline Evaluations periodically.
        type: boolean
      autoOptimizationFrequency:
        format: duration
        description: "Frequency of automatic optimization. Only relevant if IsAutoOptimizationEnabled is true.\r\nFor example, PT5M (5 mins). For information about the time format,\r\n\\r\\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations"
        type: string
      autoOptimizationStartDate:
        format: date-time
        description: Date when the first automatic optimization evaluation must be performed. Only relevant if IsAutoOptimizationEnabled is true.
        type: string
  PolicyReferenceContract:
    description: Reference to the policy within the evaluation.
    required:
    - evaluationId
    - policyName
    type: object
    properties:
      evaluationId:
        description: Evaluation Id of the evaluation.
        maxLength: 256
        type: string
      policyName:
        description: Name of the learning settings.
        maxLength: 256
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'