你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Service Configuration - Update

服务:: Azure AI Services

API 版本:: v1.1-preview.1

更新服务配置。
更新个性化体验创建服务配置。

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点。

请求正文

名称	必需	类型	说明
defaultReward	True	number (float) minimum: -1 maximum: 1	如果在指定的等待时间内未收到奖励，则给出的奖励。
explorationPercentage	True	number (float) minimum: 0 maximum: 1	将使用探索的排名响应的百分比。
logRetentionDays	True	integer (int32) minimum: -1 maximum: 2147483647	要维护历史日志的天数。 -1 表示永远不会删除日志。
modelExportFrequency	True	string (duration)	个性化体验创建服务将开始在每个指定时间段自动使用更新的已训练模型进行联机排名。例如，PT5M （5 分钟）。有关时间格式的信息，请参阅 http://en.wikipedia.org/wiki/ISO_8601#Durations
rewardAggregation	True	string maxLength: 256	用于处理奖励的函数，如果在 rewardWaitTime 结束之前收到多个奖励分数。
rewardWaitTime	True	string (duration)	等待的时间跨度，直到请求被标记为默认奖励，应介于 5 秒到 2 天之间。例如，PT5M （5 分钟）。有关时间格式的信息，请参阅 http://en.wikipedia.org/wiki/ISO_8601#Durations
autoOptimizationFrequency		string (duration)	自动优化的频率。仅当 IsAutoOptimizationEnabled 为 true 时才相关。例如，PT5M （5 分钟）。有关时间格式的信息，\r\n请参阅 http://en.wikipedia.org/wiki/ISO_8601#Durations
autoOptimizationStartDate		string (date-time)	必须执行第一次自动优化评估的日期。仅当 IsAutoOptimizationEnabled 为 true 时才相关。
isAutoOptimizationEnabled		boolean	指示个性化体验创建服务是否会定期运行脱机评估来自动优化学习设置的标志。
lastConfigurationEditDate		string (date-time)	上次更新模型训练配置的时间
learningMode		LearningMode	个性化体验创建服务的学习模式
logMirrorEnabled		boolean	标志指示是否启用日志镜像。
logMirrorSasUri		string	用于日志镜像的 Azure 存储帐户容器 SAS URI。

响应

名称	类型	说明
200 OK	ServiceConfiguration	成功
Other Status Codes	ErrorResponse	将学习模式从联机模式更改为学徒模式时，更新 defaultReward、rewardWaitTime 和 rewardAggregation，反之亦然。进行模式更改，然后使用其他 API 调用更改其他设置。

示例

Successful ServiceConfiguration_Update request

示例请求

HTTP

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

{
  "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"
}

示例响应

状态代码:: 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"
}

定义

名称	说明
ErrorResponse	用于向客户端返回错误
InternalError	包含比父对象有关错误的更具体信息的对象。
LearningMode	个性化体验创建服务的学习模式
PersonalizerError	错误对象。
PersonalizerErrorCode	个性化体验创建服务返回的错误代码
ServiceConfiguration	服务的配置。

ErrorResponse

Object

用于向客户端返回错误

名称	类型	说明
error	PersonalizerError	错误对象。

InternalError

Object

包含比父对象有关错误的更具体信息的对象。

名称	类型	说明
code	string	详细的错误代码。
innererror	InternalError	包含比父对象有关错误的更具体信息的对象。

LearningMode

枚举

个性化体验创建服务的学习模式

值	说明
Online
Apprentice
LoggingOnly

PersonalizerError

Object

错误对象。

名称	类型	说明
code	PersonalizerErrorCode	个性化体验创建服务返回的错误代码
details	PersonalizerError[]	导致此报告错误的特定错误的详细信息数组。
innerError	InternalError	包含比父对象有关错误的更具体信息的对象。
message	string	说明服务报告的错误的消息。
target	string	错误源元素。

PersonalizerErrorCode

枚举

个性化体验创建服务返回的错误代码

值	说明
BadRequest	服务器无法理解请求。
InvalidServiceConfiguration	服务配置无效。
InvalidLearningModeServiceConfiguration	将学习模式从联机模式更改为学徒模式时，更新 defaultReward、rewardWaitTime 和 rewardAggregation，反之亦然。进行模式更改，然后使用其他 API 调用更改其他设置。
InvalidPolicyConfiguration	策略配置无效。
InvalidPolicyContract	策略协定无效。
InvalidEvaluationContract	计算协定无效。
DuplicateCustomPolicyNames	自定义策略名称应是唯一的。
NoLogsExistInDateRange	日期范围内不存在日志。
LogsSizeExceedAllowedLimit	日志的总大小超出了允许的限制。
InvalidRewardRequest	奖励请求无效。
InvalidEventIdToActivate	激活事件请求无效。
InvalidRankRequest	请求无效。
InvalidExportLogsRequest	请求无效。
InvalidContainer	SAS URI 必须是具有写入权限的容器的 URI。
InvalidModelMetadata	模型元数据无效。
ApprenticeModeNeverTurnedOn	学徒模式从未打开。
MissingAppId	标头中缺少 AppId。
InvalidRewardWaitTime	奖励等待时间应介于 5 秒到 2 天之间
InvalidMultiSlotApiAccess	多槽功能当前处于禁用状态。请按照多槽个性化体验创建服务文档更新循环设置以启用多槽功能。
ModelFileAccessDenied	无法访问用于客户托管密钥的密钥保管库密钥。
ProblemTypeIncompatibleWithAutoOptimization	自动优化与多槽个性化不兼容。
ResourceNotFound	服务器上不存在请求的资源。
FrontEndNotFound	找不到前端。
EvaluationNotFound	找不到脱机评估。
LearningSettingsNotFound	评估中未找到学习设置。
EvaluationModelNotFound	评估中未找到模型。
LogsPropertiesNotFound	找不到日志属性。
ModelRankingError	使用模型对作进行排名时出错。请验证学习设置是否有效。
InternalServerError	服务器上发生了一般错误。
RankNullResponse	排名调用返回 null 响应。
UpdateConfigurationFailed	无法更新配置。
ModelResetFailed	模型重置失败。
ModelPublishFailed	模型发布失败。
ModelMetadataUpdateFailed	模型元数据更新失败。
OperationNotAllowed	目前不允许此作。

ServiceConfiguration

Object

服务的配置。

名称	类型	说明
autoOptimizationFrequency	string (duration)	自动优化的频率。仅当 IsAutoOptimizationEnabled 为 true 时才相关。例如，PT5M （5 分钟）。有关时间格式的信息，\r\n请参阅 http://en.wikipedia.org/wiki/ISO_8601#Durations
autoOptimizationStartDate	string (date-time)	必须执行第一次自动优化评估的日期。仅当 IsAutoOptimizationEnabled 为 true 时才相关。
defaultReward	number (float) minimum: -1 maximum: 1	如果在指定的等待时间内未收到奖励，则给出的奖励。
explorationPercentage	number (float) minimum: 0 maximum: 1	将使用探索的排名响应的百分比。
isAutoOptimizationEnabled	boolean	指示个性化体验创建服务是否会定期运行脱机评估来自动优化学习设置的标志。
lastConfigurationEditDate	string (date-time)	上次更新模型训练配置的时间
learningMode	LearningMode	个性化体验创建服务的学习模式
logMirrorEnabled	boolean	标志指示是否启用日志镜像。
logMirrorSasUri	string	用于日志镜像的 Azure 存储帐户容器 SAS URI。
logRetentionDays	integer (int32) minimum: -1 maximum: 2147483647	要维护历史日志的天数。 -1 表示永远不会删除日志。
modelExportFrequency	string (duration)	个性化体验创建服务将开始在每个指定时间段自动使用更新的已训练模型进行联机排名。例如，PT5M （5 分钟）。有关时间格式的信息，请参阅 http://en.wikipedia.org/wiki/ISO_8601#Durations
rewardAggregation	string maxLength: 256	用于处理奖励的函数，如果在 rewardWaitTime 结束之前收到多个奖励分数。
rewardWaitTime	string (duration)	等待的时间跨度，直到请求被标记为默认奖励，应介于 5 秒到 2 天之间。例如，PT5M （5 分钟）。有关时间格式的信息，请参阅 http://en.wikipedia.org/wiki/ISO_8601#Durations

通过

Service Configuration - Update

URI 参数

请求正文

响应

示例

Successful ServiceConfiguration_Update request

示例请求

示例响应

定义

ErrorResponse

InternalError

LearningMode

PersonalizerError

PersonalizerErrorCode

ServiceConfiguration