Microsoft Azure MultiSlotEvents API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MultiSlotEvents API
  description: Manages multi-slot event operations.
schemes:
- https
tags:
- name: MultiSlotEvents
  description: Manages multi-slot event operations.
paths:
  /multislot/events/{eventId}/reward:
    post:
      tags:
      - MultiSlotEvents
      summary: Microsoft Azure Post Multi Slot Rewards
      description: Report reward that resulted from using the action specified in rewardActionId for the slot.
      operationId: microsoftAzureMultisloteventsReward
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: eventId
        description: The event id this reward applies to.
        required: true
        type: string
        maxLength: 256
      - in: body
        name: body
        description: List of slot id and reward values. The reward should be a floating point number, typically between 0 and 1.
        required: true
        schema:
          $ref: '#/definitions/MultiSlotRewardRequest'
      responses:
        '204':
          description: Success
        default:
          description: Invalid reward request.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful MultiSlotEvents_Reward request:
          $ref: ./examples/MultiSlotEvents_Reward.json
  /multislot/events/{eventId}/activate:
    post:
      tags:
      - MultiSlotEvents
      summary: Microsoft Azure Activate Multi Slot Event
      description: Report that the specified event was actually used or displayed to the user and a rewards should be expected for it.
      operationId: microsoftAzureMultisloteventsActivate
      produces:
      - application/json
      parameters:
      - in: path
        name: eventId
        description: The event ID this activation applies to.
        required: true
        type: string
        maxLength: 256
      responses:
        '204':
          description: Success
        default:
          description: Invalid activate event request.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful MultiSlotEvents_Activate request:
          $ref: ./examples/MultiSlotEvents_Activate.json
definitions:
  ErrorResponse:
    description: Used to return an error to the client
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PersonalizerError'
  MultiSlotRewardRequest:
    description: Reward given to a list of slots.
    required:
    - reward
    type: object
    properties:
      reward:
        description: List of SlotRewards
        type: array
        items:
          $ref: '#/definitions/SlotReward'
  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'
  SlotReward:
    required:
    - slotId
    - value
    type: object
    properties:
      slotId:
        description: Slot id for which we are sending the reward.
        maxLength: 256
        minLength: 1
        type: string
      value:
        format: float
        description: Reward to be assigned to slotId. Value should be between -1 and 1 inclusive.
        type: number
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'