swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector LogsV1Dot1Preview2 API
  description: Manages reinforcement learning logs.
schemes:
- https
tags:
- name: LogsV1Dot1Preview2
  description: Manages reinforcement learning logs.
paths:
  /logs/interactions:
    post:
      tags:
      - LogsV1Dot1Preview2
      summary: Microsoft Azure Post Interactions
      description: The endpoint is intended to be used from within a SDK for logging interactions and accepts specific format defined in https://github.com/VowpalWabbit/reinforcement_learning. This endpoint should not be used by the customer.
      operationId: microsoftAzureLogInteractions
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Interactions binary payload.
        required: true
        schema:
          format: binary
          type: string
      responses:
        '204':
          description: Success
        default:
          description: Invalid request.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Log_Interactions request:
          $ref: ./examples/Log_Interactions.json
  /logs/observations:
    post:
      tags:
      - LogsV1Dot1Preview2
      summary: Microsoft Azure Post Observations
      description: The endpoint is intended to be used from within a SDK for logging observations and accepts specific format defined in https://github.com/VowpalWabbit/reinforcement_learning. This endpoint should not be used by the customer.
      operationId: microsoftAzureLogObservations
      consumes:
      - application/octet-stream
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Observations binary payload.
        required: true
        schema:
          format: binary
          type: string
      responses:
        '204':
          description: Success
        default:
          description: Invalid request.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Log_Observations request:
          $ref: ./examples/Log_Observations.json
  /logs:
    delete:
      tags:
      - LogsV1Dot1Preview2
      summary: Microsoft Azure Deletes Logs
      description: Delete all logs of Rank and Reward calls stored by Personalizer.
      operationId: microsoftAzureLogDelete
      consumes: []
      produces: []
      parameters: []
      responses:
        '204':
          description: Success
      x-ms-examples:
        Successful Log_Delete request:
          $ref: ./examples/Log_Delete.json
  /logs/properties:
    get:
      tags:
      - LogsV1Dot1Preview2
      summary: Microsoft Azure Get Log Properties
      description: Get properties of the Personalizer logs.
      operationId: microsoftAzureLogGetproperties
      consumes: []
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/LogsProperties'
        default:
          description: Log properties not found.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful Log_GetProperties request:
          $ref: ./examples/Log_GetProperties.json
definitions:
  ErrorResponse:
    description: Used to return an error to the client
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PersonalizerError'
  LogsProperties:
    description: Properties related to data used to train the model.
    type: object
    properties:
      dateRange:
        description: Date range.
        type: object
        allOf:
        - $ref: '#/definitions/DateRange'
        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: '#/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'
  DateRange:
    description: A date range starting at From and ending at To.
    type: object
    properties:
      from:
        format: date-time
        description: Start date for the range.
        type: string
        readOnly: true
      to:
        format: date-time
        description: End date for the range.
        type: string
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'