Microsoft Azure Configurations20220901Preview API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Configurations20220901 Preview API
  description: Manages configuration operations.
tags:
- name: Configurations20220901Preview
  description: Manages configuration operations.
paths:
  /configurations/service:
    get:
      tags:
      - Configurations20220901Preview
      summary: Microsoft Azure Get Service Configuration
      description: Get the Personalizer service configuration.
      operationId: microsoftAzureServiceconfigurationGet
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceConfiguration'
        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 ServiceConfiguration_Get request:
          $ref: ./examples/ServiceConfiguration_Get.json
    put:
      tags:
      - Configurations20220901Preview
      summary: Microsoft Azure Update Service Configuration
      description: Update the Personalizer service configuration.
      operationId: microsoftAzureServiceconfigurationUpdate
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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.
          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 ServiceConfiguration_Update request:
          $ref: ./examples/ServiceConfiguration_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceConfiguration'
        description: The personalizer service configuration.
        required: true
  /configurations/policy:
    get:
      tags:
      - Configurations20220901Preview
      summary: Microsoft Azure Get Policy
      description: Get the Learning Settings currently used by the Personalizer service.
      operationId: microsoftAzurePolicyGet
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyContract'
        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 Policy_Get request:
          $ref: ./examples/Policy_Get.json
    put:
      tags:
      - Configurations20220901Preview
      summary: Microsoft Azure Update Policy
      description: Update the Learning Settings that the Personalizer service will use to train models.
      operationId: microsoftAzurePolicyUpdate
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyContract'
        default:
          description: Invalid policy configuration.
          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 Policy_Update request:
          $ref: ./examples/Policy_Update.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyContract'
        description: The learning settings.
        required: true
    delete:
      tags:
      - Configurations20220901Preview
      summary: Microsoft Azure Reset Policy
      description: Resets the learning settings of the Personalizer service to default.
      operationId: microsoftAzurePolicyReset
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyContract'
        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 Policy_Reset request:
          $ref: ./examples/Policy_Reset.json
  /configurations/applyFromEvaluation:
    post:
      tags:
      - Configurations20220901Preview
      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
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Learning Settings not found in evaluation.
          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 ServiceConfiguration_ApplyFromEvaluation request:
          $ref: ./examples/ServiceConfiguration_ApplyFromEvaluation.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyReferenceContract'
        description: Reference to the policy within the evaluation.
        required: true
components:
  schemas:
    ErrorResponse:
      description: Used to return an error to the client
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PersonalizerError'
    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'
    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:
      - 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
    ServiceConfiguration:
      description: The configuration of the service.
      required:
      - defaultReward
      - explorationPercentage
      - logRetentionDays
      - modelExportFrequency
      - modelRetrainDays
      - rewardAggregation
      - rewardWaitTime
      type: object
      properties:
        rewardWaitTime:
          format: duration
          description: 'The time span waited until a request is marked with the default reward

            and should be between 5 seconds and 2 days.

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

            see 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.

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

            see 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.

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

            \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
        modelRetrainDays:
          format: int32
          description: Number of days of historical logs used when a model retrain is triggered.
          default: 0
          maximum: 2147483647
          minimum: 0
          type: integer
    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: '#/components/parameters/Endpoint'