Microsoft Azure LogsV1Dot1Preview2 API

openapi: 3.2.0
info:
  title: Microsoft Azure Logs V1 Dot1 Preview2 API
  version: '1.0'
  description: 'Operations tagged LogsV1Dot1Preview2 across 2 of this provider''s published API definitions: personalizer-client-2022-09-01-preview-openapi-original.yml, personalizer-client-v11-preview3-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /personalizer
- url: /personalizer/v1.1-preview.3
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
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Invalid request.
          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 Log_Interactions request:
          $ref: ./examples/Log_Interactions.json
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
        description: Interactions binary payload.
        required: true
      security:
      - {}
    servers:
    - url: /personalizer
  /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
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Invalid request.
          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 Log_Observations request:
          $ref: ./examples/Log_Observations.json
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
        description: Observations binary payload.
        required: true
      security:
      - {}
    servers:
    - url: /personalizer
  /logs:
    delete:
      tags:
      - LogsV1Dot1Preview2
      summary: Microsoft Azure Deletes Logs
      description: Delete all logs of Rank and Reward calls stored by Personalizer.
      operationId: microsoftAzureLogDelete
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '204':
          description: No Content
        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 Log_Delete request:
          $ref: ./examples/Log_Delete.json
      security:
      - {}
    servers:
    - url: /personalizer
  /logs/properties:
    get:
      tags:
      - LogsV1Dot1Preview2
      summary: Microsoft Azure Get Log Properties
      description: Get properties of the Personalizer logs.
      operationId: microsoftAzureLogGetproperties
      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/LogsProperties'
        default:
          description: Log properties not found.
          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 Log_GetProperties request:
          $ref: ./examples/Log_GetProperties.json
      security:
      - {}
    servers:
    - url: /personalizer
components:
  schemas:
    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'
    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
    LogsProperties:
      description: Properties related to data used to train the model.
      type: object
      properties:
        dateRange:
          $ref: '#/components/schemas/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: '#/components/schemas/InternalError'
    ErrorResponse:
      description: Used to return an error to the client
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PersonalizerError'
    PersonalizerError_2:
      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
          - InvalidLogRetentionDays
          - InvalidMultiSlotApiAccess
          - PayloadSizeExceeded
          - InvalidModelImportSignature
          - InvalidModelImportFormat
          - InvalidApiAccess
          - 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 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: 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: 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: '#/components/schemas/PersonalizerError_2'
        innerError:
          $ref: '#/components/schemas/InternalError'
    LogsProperties_2:
      description: Properties related to data used to train the model.
      type: object
      properties:
        dateRange:
          description: Date range.
          type: object
          allOf:
          - $ref: '#/components/schemas/DateRange'
          readOnly: true
  securitySchemes:
    apim_key:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
x-refined-from:
- personalizer-client-2022-09-01-preview-openapi-original.yml
- personalizer-client-v11-preview3-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'