Service Configuration - Get

Service:

Cognitive Services - Personalizer

API Version:

v1.1-preview.1

Get Service Configuration.
Get the Personalizer service configuration.

GET {Endpoint}/personalizer/v1.1-preview.1/configurations/service

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint.

Responses

Name	Type	Description
200 OK	ServiceConfiguration	Success

Examples

Successful ServiceConfiguration_Get request

Sample Request

HTTP

GET {Endpoint}/personalizer/v1.1-preview.1/configurations/service

Sample Response

Status code:

200

{
  "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
LearningMode	Learning Modes for Personalizer
ServiceConfiguration	The configuration of the service.

LearningMode

Learning Modes for Personalizer

Name	Type	Description
Apprentice	string
LoggingOnly	string
Online	string

ServiceConfiguration

The configuration of the service.

Name	Type	Description
autoOptimizationFrequency	string	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 when the first automatic optimization evaluation must be performed. Only relevant if IsAutoOptimizationEnabled is true.
defaultReward	number	The reward given if a reward is not received within the specified wait time.
explorationPercentage	number	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	Last time model training configuration was updated
learningMode	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	Number of days historical logs are to be maintained. -1 implies the logs will never be deleted.
modelExportFrequency	string	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	The function used to process rewards, if multiple reward scores are received before rewardWaitTime is over.
rewardWaitTime	string	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