Microsoft Azure ModelV1Dot1Preview3 API

Manages reinforcement learning configuration operations.

Documentation GitHub OpenAPI

Business capability

Artificial Intelligence Management BC-610.60

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /model Download the Personalizer model file · Microsoft Azure Get Model #

Ask an LLM

“Can I export the model my Personalizer loop has learned?”

“Is there a way to download the model as a signed zip archive?”

Tell an agent

Download the current Personalizer model file.

Export the Personalizer model as a signed archive ({signed}).

PUT /model Replace the Personalizer model with my own file · Microsoft Azure Put The Digitally Signed Model File #

Ask an LLM

“How do I upload a previously exported model back into Personalizer?”

“Does importing a model overwrite the one Personalizer is using now?”

Tell an agent destructive · confirm first

Replace the existing Personalizer model with the file I provide.

Import my model file into Personalizer using API version {api_version}.

DELETE /model Reset the Personalizer model · Microsoft Azure Reset Model #

Ask an LLM

“Can I wipe what Personalizer has learned and start the model over?”

“What happens to rankings after I reset the model?”

Tell an agent destructive · confirm first

Reset the Personalizer model to a fresh state.

Clear the learned Personalizer model on API version {api_version}.

GET /model/properties Get the Personalizer model's properties · Microsoft Azure Get Model Properties #

Ask an LLM

“Can I check the properties of the model file Personalizer generated?”

“What metadata does Personalizer keep about its current model?”

Tell an agent

Show the properties of the current Personalizer model.

Get the model metadata for Personalizer on API version {api_version}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure:microsoft-azure-modelv1dot1preview3-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Model V1Dot1 Preview3 API
  version: '1.0'
  description: 'Operations tagged ModelV1Dot1Preview3 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: ModelV1Dot1Preview3
  description: Manages reinforcement learning configuration operations.
paths:
  /model:
    get:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Get Model
      description: Get the model file generated by Personalizer service.
      operationId: microsoftAzureModelGet
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      - in: query
        name: signed
        description: True if requesting signed model zip archive, false otherwise.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
        default:
          description: Requested resource does not exist on the server.
          headers:
            x-ms-error-code:
              description: Error code for specific error that occurred.
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Successful Model_Get request:
          $ref: ./examples/Model_Get.json
      security:
      - {}
    put:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Put The Digitally Signed Model File
      description: Replace the existing model file for the Personalizer service.
      operationId: microsoftAzureModelImport
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Given model file is not signed or does not have a valid signature.
          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 Model_Import request:
          $ref: ./examples/Model_Import.json
      requestBody:
        content:
          application/octet-stream:
            schema:
              format: binary
              type: string
        description: The digitally signed model file obtained from getting the model.
        required: true
      security:
      - {}
    delete:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Reset Model
      description: Resets the model file generated by Personalizer service.
      operationId: microsoftAzureModelReset
      parameters:
      - name: api-version
        in: query
        required: true
        description: Client API version.
        schema:
          type: string
      responses:
        '204':
          description: No Content
        default:
          description: Model reset failed.
          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 Model_Reset request:
          $ref: ./examples/Model_Reset.json
      security:
      - {}
    servers:
    - url: /personalizer
  /model/properties:
    get:
      tags:
      - ModelV1Dot1Preview3
      summary: Microsoft Azure Get Model Properties
      description: Get properties of the model file generated by Personalizer service.
      operationId: microsoftAzureModelGetproperties
      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/ModelProperties'
        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 Model_GetProperties request:
          $ref: ./examples/Model_GetProperties.json
      security:
      - {}
    servers:
    - url: /personalizer
components:
  schemas:
    ModelProperties:
      description: Properties related to the trained model.
      type: object
      properties:
        creationTime:
          format: date-time
          description: Creation time of the model.
          type: string
          readOnly: true
        lastModifiedTime:
          format: date-time
          description: Last time the model was modified.
          type: string
          readOnly: true
    ErrorResponse:
      description: Used to return an error to the client
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/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: '#/components/schemas/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
          - 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'
    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'
  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'

Microsoft Azure ModelV1Dot1Preview3 API

Operations 4

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification