Microsoft Azure Personalizer Client 20220901preview is a tool that allows users to incorporate personalized recommendations into their applications. This client leverages machine learning algorithms to analyze user behavior and preferences, providing tailored suggestions for content, products, or services. By utilizing this tool, developers can improve user engagement and satisfaction by delivering relevant and timely recommendations.
swagger: '2.0'
info:
version: 2022-09-01-preview
title: Microsoft Azure Personalizer Client 2022-09-01-preview
description: >-
Personalizer Service is an Azure Cognitive Service that makes it easy to
target content and experiences without complex pre-analysis or cleanup of
past data. Given a context and featurized content, the Personalizer Service
returns which content item to show to users in rewardActionId. As rewards
are sent in response to the use of rewardActionId, the reinforcement
learning algorithm will improve the model and improve performance of future
rank calls.
basePath: /personalizer
schemes:
- https
paths:
/configurations/service:
get:
tags:
- Configurations20220901Preview
summary: 'Microsoft Azure Get Service Configuration'
description: Get the Personalizer service configuration.
operationId: microsoftAzureServiceconfigurationGet
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ServiceConfiguration'
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/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
consumes:
- application/json
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- name: config
in: body
description: The personalizer service configuration.
required: true
schema:
$ref: '#/definitions/ServiceConfiguration'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/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:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful ServiceConfiguration_Update request:
$ref: ./examples/ServiceConfiguration_Update.json
/configurations/policy:
get:
tags:
- Configurations20220901Preview
summary: 'Microsoft Azure Get Policy'
description: Get the Learning Settings currently used by the Personalizer service.
operationId: microsoftAzurePolicyGet
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PolicyContract'
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/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
consumes:
- application/json
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- name: policy
in: body
description: The learning settings.
required: true
schema:
$ref: '#/definitions/PolicyContract'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PolicyContract'
default:
description: Invalid policy configuration.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Policy_Update request:
$ref: ./examples/Policy_Update.json
delete:
tags:
- Configurations20220901Preview
summary: 'Microsoft Azure Reset Policy'
description: Resets the learning settings of the Personalizer service to default.
operationId: microsoftAzurePolicyReset
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PolicyContract'
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Policy_Reset request:
$ref: ./examples/Policy_Reset.json
/evaluations/{evaluationId}:
get:
tags:
- Evaluations20220901Preview
summary: 'Microsoft Azure Get Evaluation'
description: Get the Offline Evaluation associated with the Id.
operationId: microsoftAzureEvaluationsGet
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- name: evaluationId
in: path
description: Id of the Offline Evaluation.
required: true
type: string
maxLength: 256
- in: query
name: intervalInMinutes
description: >-
"Time interval for aggregation of events in minutes. Allowed
intervals: 5 minutes, 60 minutes, 360 minutes, 720 minutes and 1440
minutes. Defaults to 5 minutes.
type: integer
format: int32
- in: query
name: startTime
description: Start of aggregation time interval.
type: string
format: date-time
required: true
- in: query
name: endTime
description: End of aggregation time interval.
type: string
format: date-time
required: true
- in: query
name: window
description: >-
Rolling or Expanding time. Rolling compatible with 60 minutes, 360
minutes, 720 minutes and 1440 minutes intervals. Expanding
compatible with 5 minute time interval only. Defaults to Expanding.
type: string
enum:
- Expanding
- Rolling
x-ms-enum:
name: Window
modelAsString: true
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Evaluation'
default:
description: Offline Evaluation not found.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Evaluations_Get request:
$ref: ./examples/Evaluations_Get.json
delete:
tags:
- Evaluations20220901Preview
summary: 'Microsoft Azure Delete Evaluation'
description: Delete the Offline Evaluation associated with the Id.
operationId: microsoftAzureEvaluationsDelete
consumes: []
produces: []
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- name: evaluationId
in: path
description: Id of the Offline Evaluation to delete.
required: true
type: string
maxLength: 256
responses:
'204':
description: No Content
default:
description: Offline Evaluation not found.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Evaluations_Delete request:
$ref: ./examples/Evaluations_Delete.json
put:
tags:
- Evaluations20220901Preview
summary: 'Microsoft Azure Create Offline Evaluation'
description: Submit a new Offline Evaluation job.
operationId: microsoftAzureEvaluationsCreate
consumes:
- application/json
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: path
name: evaluationId
description: Id of the Offline Evaluation to create.
required: true
type: string
maxLength: 256
- in: body
name: evaluation
description: The Offline Evaluation job definition.
required: true
schema:
$ref: '#/definitions/EvaluationContract'
responses:
'200':
description: Success
default:
description: Invalid contract.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Evaluations_Create request:
$ref: ./examples/Evaluations_Create.json
/evaluations:
get:
tags:
- Evaluations20220901Preview
summary: 'Microsoft Azure List Offline Evaluations'
description: List of all Offline Evaluations.
operationId: microsoftAzureEvaluationsList
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: query
name: filter
description: "An expression to filter the evaluations against evaluation metadata. Only evaluations where the expression evaluates to true are included in the response.\r\nHere is an example, metadata=evaluationType eq 'Manual'."
type: string
- in: query
name: top
description: >-
The maximum number of resources to return from the collection.
Defaults to maximum value of integer.
type: integer
format: int32
- in: query
name: skip
description: >-
An offset into the collection of the first resource to be returned.
Defaults to 0.
type: integer
format: int32
default: 0
- in: query
name: maxpagesize
description: >-
The maximum number of resources to include in a single response.
Defaults to 100.
type: integer
format: int32
responses:
'200':
description: Success
schema:
$ref: '#/definitions/Evaluations'
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Evaluations_List request:
$ref: ./examples/Evaluations_List.json
/events/{eventId}/reward:
post:
tags:
- Events
summary: 'Microsoft Azure Post Reward'
description: >-
Report reward between 0 and 1 that resulted from using the action
specified in rewardActionId, for the specified event.
operationId: microsoftAzureEventsReward
consumes:
- application/json
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- name: eventId
in: path
description: The event id this reward applies to.
required: true
type: string
maxLength: 256
- name: reward
in: body
description: >-
The reward should be a floating point number, typically between 0
and 1.
required: true
schema:
$ref: '#/definitions/RewardRequest'
responses:
'204':
description: No Content
default:
description: Invalid reward request.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Events_Reward request:
$ref: ./examples/Events_Reward.json
/events/{eventId}/activate:
post:
tags:
- Events
summary: 'Microsoft Azure Activate Event'
description: >-
Report that the specified event was actually used (e.g. by being
displayed to the user) and a reward should be expected for it.
operationId: microsoftAzureEventsActivate
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- name: eventId
in: path
description: The event ID to be activated.
required: true
type: string
maxLength: 256
responses:
'204':
description: No Content
default:
description: Invalid activate event request.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Events_Activate request:
$ref: ./examples/Events_Activate.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
consumes:
- application/json
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: body
name: body
description: Reference to the policy within the evaluation.
required: true
schema:
$ref: '#/definitions/PolicyReferenceContract'
responses:
'204':
description: No Content
default:
description: Learning Settings not found in evaluation.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful ServiceConfiguration_ApplyFromEvaluation request:
$ref: ./examples/ServiceConfiguration_ApplyFromEvaluation.json
description: Needs a more full description created.
/featureImportances/{featureImportanceId}:
delete:
tags:
- FeatureImportances20220901Preview
summary: 'Microsoft Azure Delete Feature Importance'
description: Delete the Feature Importance associated with the Id.
operationId: microsoftAzureFeatureimportancesDelete
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: path
name: featureImportanceId
description: Id of the Feature Importance to delete.
required: true
type: string
maxLength: 256
responses:
'204':
description: No Content
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful FeatureImportances_Delete request:
$ref: ./examples/FeatureImportances_Delete.json
get:
tags:
- FeatureImportances20220901Preview
summary: 'Microsoft Azure Get Feature Importance'
description: Get the Feature Importance associated with the Id.
operationId: microsoftAzureFeatureimportancesGet
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: path
name: featureImportanceId
description: Id of the Feature Importance.
required: true
type: string
maxLength: 256
responses:
'200':
description: Success
schema:
$ref: '#/definitions/FeatureImportance'
default:
description: Feature importance not found.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful FeatureImportances_Get request:
$ref: ./examples/FeatureImportances_Get.json
put:
tags:
- FeatureImportances20220901Preview
summary: 'Microsoft Azure Create Feature Importance'
description: Submit a new Feature Importance job.
operationId: microsoftAzureFeatureimportancesCreate
consumes:
- application/json
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: path
name: featureImportanceId
description: Id of the Feature Importance to create.
required: true
type: string
maxLength: 256
- in: body
name: featureImportance
description: The Feature Importance job definition.
required: true
schema:
$ref: '#/definitions/FeatureImportanceContract'
responses:
'200':
description: Success
default:
description: Invalid contract.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful FeatureImportances_Create request:
$ref: ./examples/FeatureImportances_Create.json
/featureImportances:
get:
tags:
- FeatureImportances20220901Preview
summary: 'Microsoft Azure List Feature Importances'
description: List of all Feature Importances.
operationId: microsoftAzureFeatureimportancesList
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: query
name: top
description: >-
The maximum number of resources to return from the collection.
Defaults to maximum value of integer.
type: integer
format: int32
- in: query
name: skip
description: >-
An offset into the collection of the first resource to be returned.
Defaults to 0.
type: integer
format: int32
default: 0
- in: query
name: maxpagesize
description: >-
The maximum number of resources to include in a single response.
Defaults to 100.
type: integer
format: int32
responses:
'200':
description: Success
schema:
$ref: '#/definitions/FeatureImportances'
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful FeatureImportances_List request:
$ref: ./examples/FeatureImportances_List.json
/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:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: body
name: body
description: Interactions binary payload.
required: true
schema:
format: binary
type: string
responses:
'204':
description: No Content
default:
description: Invalid request.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
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:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: body
name: body
description: Observations binary payload.
required: true
schema:
format: binary
type: string
responses:
'204':
description: No Content
default:
description: Invalid request.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
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:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'204':
description: No Content
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
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:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'200':
description: Success
schema:
$ref: '#/definitions/LogsProperties'
default:
description: Log properties not found.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Log_GetProperties request:
$ref: ./examples/Log_GetProperties.json
/model:
get:
tags:
- ModelV1Dot1Preview3
summary: 'Microsoft Azure Get Model'
description: Get the model file generated by Personalizer service.
operationId: microsoftAzureModelGet
consumes: []
produces:
- application/octet-stream
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: query
name: signed
description: True if requesting signed model zip archive, false otherwise.
type: boolean
default: false
responses:
'200':
description: Success
schema:
type: file
default:
description: Requested resource does not exist on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Model_Get request:
$ref: ./examples/Model_Get.json
put:
tags:
- ModelV1Dot1Preview3
summary: 'Microsoft Azure Put The Digitally Signed Model File'
description: Replace the existing model file for the Personalizer service.
operationId: microsoftAzureModelImport
consumes:
- application/octet-stream
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- in: body
name: body
description: The digitally signed model file obtained from getting the model.
required: true
schema:
format: binary
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:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Model_Import request:
$ref: ./examples/Model_Import.json
delete:
tags:
- ModelV1Dot1Preview3
summary: 'Microsoft Azure Reset Model'
description: Resets the model file generated by Personalizer service.
operationId: microsoftAzureModelReset
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'204':
description: No Content
default:
description: Model reset failed.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Model_Reset request:
$ref: ./examples/Model_Reset.json
/model/properties:
get:
tags:
- ModelV1Dot1Preview3
summary: 'Microsoft Azure Get Model Properties'
description: Get properties of the model file generated by Personalizer service.
operationId: microsoftAzureModelGetproperties
consumes: []
produces:
- application/json
parameters:
- name: api-version
in: query
required: true
type: string
description: Client API version.
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ModelProperties'
default:
description: A generic error has occurred on the server.
headers:
x-ms-error-code:
type: string
description: Error code for specific error that occurred.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-examples:
Successful Model_GetProperties request:
$ref: ./examples/Model_GetProperties.json
/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:
- name: api-version
in: query
required: true
type: string
description: Client API version.
- 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: No Content
default:
description: Invalid reward request.
headers:
x-ms-error-code:
type: string
description: Error code for s
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/personalizer-client-2022-09-01-preview-openapi-original.yml