Service Configuration - Get
Get Service Configuration.
Get the Personalizer service configuration.
GET {Endpoint}/personalizer/v1.1-preview.1/configurations/serviceURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Supported Cognitive Services endpoint. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Success |
Examples
Successful ServiceConfiguration_Get request
Sample request
GET {Endpoint}/personalizer/v1.1-preview.1/configurations/service
Sample response
{
"rewardWaitTime": "PT10M",
"defaultReward": 0,
"rewardAggregation": "earliest",
"explorationPercentage": 0.2,
"modelExportFrequency": "PT5M",
"logMirrorEnabled": true,
"logMirrorSasUri": "https://testblob.blob.core.windows.net/container?se=2020-08-13T00%3A00Z&sp=rwl&spr=https&sv=2018-11-09&sr=c&sig=signature",
"logRetentionDays": 7,
"lastConfigurationEditDate": "0001-01-01T00:00:00Z",
"learningMode": "Online",
"isAutoOptimizationEnabled": true,
"autoOptimizationFrequency": "P7D",
"autoOptimizationStartDate": "2019-01-19T00:00:00Z"
}Definitions
| Name | Description |
|---|---|
|
Learning |
Learning Modes for Personalizer |
|
Service |
The configuration of the service. |
LearningMode
Learning Modes for Personalizer
| Value | Description |
|---|---|
| Online | |
| Apprentice | |
| LoggingOnly |
ServiceConfiguration
The configuration of the service.
| Name | Type | Description |
|---|---|---|
| autoOptimizationFrequency |
string (duration) |
Frequency of automatic optimization. Only relevant if IsAutoOptimizationEnabled is true. For example, PT5M (5 mins). For information about the time format, \r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations |
| autoOptimizationStartDate |
string (date-time) |
Date when the first automatic optimization evaluation must be performed. Only relevant if IsAutoOptimizationEnabled is true. |
| defaultReward |
number (float) minimum: -1maximum: 1 |
The reward given if a reward is not received within the specified wait time. |
| explorationPercentage |
number (float) minimum: 0maximum: 1 |
The percentage of rank responses that will use exploration. |
| isAutoOptimizationEnabled |
boolean |
Flag indicating whether Personalizer will automatically optimize Learning Settings by running Offline Evaluations periodically. |
| lastConfigurationEditDate |
string (date-time) |
Last time model training configuration was updated |
| learningMode |
Learning Modes for Personalizer |
|
| logMirrorEnabled |
boolean |
Flag indicates whether log mirroring is enabled. |
| logMirrorSasUri |
string |
Azure storage account container SAS URI for log mirroring. |
| logRetentionDays |
integer (int32) minimum: -1maximum: 2147483647 |
Number of days historical logs are to be maintained. -1 implies the logs will never be deleted. |
| modelExportFrequency |
string (duration) |
Personalizer will start using the most updated trained model for online ranks automatically every specified time period. For example, PT5M (5 mins). For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations |
| rewardAggregation |
string maxLength: 256 |
The function used to process rewards, if multiple reward scores are received before rewardWaitTime is over. |
| rewardWaitTime |
string (duration) |
The time span waited until a request is marked with the default reward and should be between 5 seconds and 2 days. For example, PT5M (5 mins). For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations |