Service Configuration - Update

參考

服務:: Cognitive Services - Personalizer

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

更新服務組態。
更新個人化工具服務組態。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。

要求本文

名稱	必要	類型	Description
defaultReward	True	number	如果在指定的等候時間內未收到獎勵，則為指定的獎勵。
explorationPercentage	True	number	將使用探索的排名回應百分比。
logRetentionDays	True	integer	要維護歷程記錄的天數。 -1 表示永遠不會刪除記錄。
modelExportFrequency	True	string	個人化工具會在每個指定的時間週期自動使用在線排名的更新定型模型。例如，PT5M (5 分鐘) 。如需時間格式的相關信息，請參閱 http://en.wikipedia.org/wiki/ISO_8601#Durations
rewardAggregation	True	string	在 rewardWaitTime 超過之前收到多個獎勵分數時，用來處理獎勵的函式。
rewardWaitTime	True	string	等候到要求標示為預設獎勵的時間範圍，應該介於 5 秒到 2 天之間。例如，PT5M (5 分鐘) 。如需時間格式的相關信息，請參閱 http://en.wikipedia.org/wiki/ISO_8601#Durations
autoOptimizationFrequency		string	自動優化的頻率。只有在IsAutoOptimizationEnabled 為 true 時才相關。例如，PT5M (5 分鐘) 。如需時間格式的相關信息，請參閱 \r\nhttp://en.wikipedia.org/wiki/ISO_8601#Durations
autoOptimizationStartDate		string	必須執行第一個自動優化評估的日期。只有在IsAutoOptimizationEnabled 為 true 時才相關。
isAutoOptimizationEnabled		boolean	旗標，指出個人化工具是否會定期執行離線評估，自動優化學習設定。
lastConfigurationEditDate		string	上次更新模型定型設定的時間
learningMode		LearningMode	個人化工具的學習模式
logMirrorEnabled		boolean	旗標指出是否啟用記錄鏡像。
logMirrorSasUri		string	用於記錄鏡像的 Azure 記憶體帳戶容器 SAS URI。

回應

名稱	類型	Description
200 OK	ServiceConfiguration	Success
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"
}

定義

名稱	Description
ErrorResponse	用來將錯誤傳回給用戶端
InternalError	物件，包含比父對象有關錯誤的更特定資訊。
LearningMode	個人化工具的學習模式
PersonalizerError	error 物件。
PersonalizerErrorCode	個人化工具傳回的錯誤碼
ServiceConfiguration	服務的組態。

ErrorResponse

用來將錯誤傳回給用戶端

名稱	類型	Description
error	PersonalizerError	error 物件。

InternalError

物件，包含比父對象有關錯誤的更特定資訊。

名稱	類型	Description
code	string	詳細的錯誤碼。
innererror	InternalError	物件，包含比父對象有關錯誤的更特定資訊。

LearningMode

個人化工具的學習模式

名稱	類型	Description
Apprentice	string
LoggingOnly	string
Online	string

PersonalizerError

error 物件。

名稱	類型	Description
code	PersonalizerErrorCode	個人化工具傳回的錯誤碼
details	PersonalizerError[]	導致此錯誤之特定錯誤的詳細數據陣列。
innerError	InternalError	物件，包含比父對象有關錯誤的更特定資訊。
message	string	說明服務所報告錯誤的訊息。
target	string	錯誤來源專案。

PersonalizerErrorCode

個人化工具傳回的錯誤碼

名稱	類型	Description
ApprenticeModeNeverTurnedOn	string	從未開啟過中性模式。
BadRequest	string	伺服器無法瞭解要求。
DuplicateCustomPolicyNames	string	自定義原則名稱應該是唯一的。
EvaluationModelNotFound	string	評估中找不到模型。
EvaluationNotFound	string	找不到離線評估。
FrontEndNotFound	string	找不到前端。
InternalServerError	string	伺服器上已經發生泛用錯誤。
InvalidContainer	string	SAS Uri 必須是具有寫入許可權的容器 URI。
InvalidEvaluationContract	string	評估合約無效。
InvalidEventIdToActivate	string	無效的啟動事件要求。
InvalidExportLogsRequest	string	無效的要求
InvalidLearningModeServiceConfiguration	string	將學習模式從 [在線] 變更為 [基本] 模式時，更新 defaultReward、rewardWaitTime 和 rewardAggregation，反之亦然。進行模式變更，然後使用額外的 API 呼叫來變更其他設定。
InvalidModelMetadata	string	無效的模型元數據。
InvalidMultiSlotApiAccess	string	多重位置功能目前已停用。請遵循多重位置個人化工具檔來更新循環設定，以啟用多重位置功能。
InvalidPolicyConfiguration	string	無效的原則設定。
InvalidPolicyContract	string	無效的原則合約。
InvalidRankRequest	string	無效的要求
InvalidRewardRequest	string	無效的獎勵要求。
InvalidRewardWaitTime	string	獎勵等候時間應介於 5 秒到 2 天之間
InvalidServiceConfiguration	string	無效的服務設定
LearningSettingsNotFound	string	評估中找不到學習設定。
LogsPropertiesNotFound	string	找不到記錄檔屬性。
LogsSizeExceedAllowedLimit	string	記錄大小總計超過允許的限制。
MissingAppId	string	標頭中缺少AppId。
ModelFileAccessDenied	string	無法存取用於客戶管理金鑰的金鑰保存庫金鑰。
ModelMetadataUpdateFailed	string	模型元數據更新失敗。
ModelPublishFailed	string	模型發佈失敗。
ModelRankingError	string	使用模型進行排名動作時發生錯誤。請確認學習設定有效。
ModelResetFailed	string	模型重設失敗。
NoLogsExistInDateRange	string	日期範圍中沒有記錄。
OperationNotAllowed	string	目前不允許此作業。
ProblemTypeIncompatibleWithAutoOptimization	string	自動優化與多位置個人化不相容。
RankNullResponse	string	排名呼叫傳回 Null 回應。
ResourceNotFound	string	要求的資源不存在於伺服器上。
UpdateConfigurationFailed	string	無法更新組態。

ServiceConfiguration

服務的組態。

名稱	類型	Description
autoOptimizationFrequency	string	自動優化的頻率。只有在IsAutoOptimizationEnabled 為 true 時才相關。例如，PT5M (5 分鐘) 。如需時間格式的相關信息，請參閱 \r\nhttp://en.wikipedia.org/wiki/ISO_8601#Durations
autoOptimizationStartDate	string	必須執行第一個自動優化評估的日期。只有在IsAutoOptimizationEnabled 為 true 時才相關。
defaultReward	number	如果在指定的等候時間內未收到獎勵，則為指定的獎勵。
explorationPercentage	number	將使用探索的排名回應百分比。
isAutoOptimizationEnabled	boolean	旗標，指出個人化工具是否會定期執行離線評估，自動優化學習設定。
lastConfigurationEditDate	string	上次更新模型定型設定的時間
learningMode	LearningMode	個人化工具的學習模式
logMirrorEnabled	boolean	旗標指出是否啟用記錄鏡像。
logMirrorSasUri	string	用於記錄鏡像的 Azure 記憶體帳戶容器 SAS URI。
logRetentionDays	integer	要維護歷程記錄的天數。 -1 表示永遠不會刪除記錄。
modelExportFrequency	string	個人化工具會在每個指定的時間週期自動使用在線排名的更新定型模型。例如，PT5M (5 分鐘) 。如需時間格式的相關信息，請參閱 http://en.wikipedia.org/wiki/ISO_8601#Durations
rewardAggregation	string	在 rewardWaitTime 超過之前收到多個獎勵分數時，用來處理獎勵的函式。
rewardWaitTime	string	等候到要求標示為預設獎勵的時間範圍，應該介於 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

其他資源