@azure-rest/ai-personalizer package
Interfaces
| DateRangeOutput | |
| ErrorResponseOutput | |
| EvaluationContract | |
| EvaluationOutput | |
| EvaluationsCreate201Headers | |
| EvaluationsCreate201Response |
Submit a new Offline Evaluation job. |
| EvaluationsCreateBodyParam | |
| EvaluationsCreateMediaTypesParam | |
| EvaluationsCreatedefaultResponse |
Submit a new Offline Evaluation job. |
| EvaluationsDelete204Response |
Delete the Offline Evaluation associated with the Id. |
| EvaluationsGet | |
| EvaluationsGet200Response |
Get the Offline Evaluation associated with the Id. |
| EvaluationsGetdefaultResponse |
Get the Offline Evaluation associated with the Id. |
| EvaluationsList | |
| EvaluationsList200Response |
List of all Offline Evaluations. |
| EventsActivate | |
| EventsActivate204Response |
Report that the specified event was actually used (e.g. by being displayed to the user) and a reward should be expected for it. |
| EventsActivatedefaultResponse |
Report that the specified event was actually used (e.g. by being displayed to the user) and a reward should be expected for it. |
| EventsReward | |
| EventsReward204Response |
Report reward between 0 and 1 that resulted from using the action specified in rewardActionId, for the specified event. |
| EventsRewardBodyParam | |
| EventsRewardMediaTypesParam | |
| EventsRewarddefaultResponse |
Report reward between 0 and 1 that resulted from using the action specified in rewardActionId, for the specified event. |
| InternalErrorOutput | |
| LogDelete | |
| LogDelete204Response |
Delete all logs of Rank and Reward calls stored by Personalizer. |
| LogGetProperties | |
| LogGetProperties200Response |
Get properties of the Personalizer logs. |
| LogGetPropertiesdefaultResponse |
Get properties of the Personalizer logs. |
| LogInteractions | |
| LogInteractions204Response |
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. |
| LogInteractionsBodyParam | |
| LogInteractionsMediaTypesParam | |
| LogInteractionsdefaultResponse |
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. |
| LogObservations | |
| LogObservations204Response |
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. |
| LogObservationsBodyParam | |
| LogObservationsMediaTypesParam | |
| LogObservationsdefaultResponse |
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. |
| LogsPropertiesDateRangeOutput | |
| LogsPropertiesOutput | |
| ModelGet | |
| ModelGet200Response |
Get the model file generated by Personalizer service. |
| ModelGetProperties | |
| ModelGetProperties200Response |
Get properties of the model file generated by Personalizer service. |
| ModelGetQueryParam | |
| ModelGetQueryParamProperties | |
| ModelGetdefaultResponse |
Get the model file generated by Personalizer service. |
| ModelImport204Response |
Replace the existing model file for the Personalizer service. |
| ModelImportBodyParam | |
| ModelImportMediaTypesParam | |
| ModelImportdefaultResponse |
Replace the existing model file for the Personalizer service. |
| ModelPropertiesOutput | |
| ModelReset204Response |
Resets the model file generated by Personalizer service. |
| ModelResetdefaultResponse |
Resets the model file generated by Personalizer service. |
| MultiSlotEventsActivate | |
| MultiSlotEventsActivate204Response |
Report that the specified event was actually used or displayed to the user and a rewards should be expected for it. |
| MultiSlotEventsActivatedefaultResponse |
Report that the specified event was actually used or displayed to the user and a rewards should be expected for it. |
| MultiSlotEventsReward | |
| MultiSlotEventsReward204Response |
Report reward that resulted from using the action specified in rewardActionId for the slot. |
| MultiSlotEventsRewardBodyParam | |
| MultiSlotEventsRewardMediaTypesParam | |
| MultiSlotEventsRewarddefaultResponse |
Report reward that resulted from using the action specified in rewardActionId for the slot. |
| MultiSlotRank | |
| MultiSlotRank201Response |
Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId. |
| MultiSlotRankBodyParam | |
| MultiSlotRankMediaTypesParam | |
| MultiSlotRankRequest | |
| MultiSlotRankResponseOutput | |
| MultiSlotRankdefaultResponse |
Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId. |
| MultiSlotRewardRequest | |
| PersonalizerErrorOutput | |
| PolicyContract | |
| PolicyContractOutput | |
| PolicyGet | |
| PolicyGet200Response |
Get the Learning Settings currently used by the Personalizer service. |
| PolicyReferenceContract | |
| PolicyReset200Response |
Resets the learning settings of the Personalizer service to default. |
| PolicyResultOutput | |
| PolicyResultSummaryOutput | |
| PolicyResultTotalSummaryOutput | |
| PolicyUpdate200Response |
Update the Learning Settings that the Personalizer service will use to train models. |
| PolicyUpdateBodyParam | |
| PolicyUpdateMediaTypesParam | |
| PolicyUpdatedefaultResponse |
Update the Learning Settings that the Personalizer service will use to train models. |
| Rank | |
| Rank201Response |
Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId. |
| RankBodyParam | |
| RankMediaTypesParam | |
| RankRequest | |
| RankResponseOutput | |
| RankableAction | |
| RankdefaultResponse |
Submit a Personalizer rank request. Receives a context and a list of actions. Returns which of the provided actions should be used by your application, in rewardActionId. |
| RankedActionOutput | |
| RewardRequest | |
| Routes | |
| ServiceConfiguration | |
| ServiceConfigurationApplyFromEvaluation | |
| ServiceConfigurationApplyFromEvaluation204Response |
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. |
| ServiceConfigurationApplyFromEvaluationBodyParam | |
| ServiceConfigurationApplyFromEvaluationMediaTypesParam | |
| ServiceConfigurationApplyFromEvaluationdefaultResponse |
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. |
| ServiceConfigurationGet | |
| ServiceConfigurationGet200Response |
Get the Personalizer service configuration. |
| ServiceConfigurationOutput | |
| ServiceConfigurationUpdate200Response |
Update the Personalizer service configuration. |
| ServiceConfigurationUpdateBodyParam | |
| ServiceConfigurationUpdateMediaTypesParam | |
| ServiceConfigurationUpdatedefaultResponse |
Update the Personalizer service configuration. |
| SlotRequest | |
| SlotResponseOutput | |
| SlotReward | |
Type Aliases
Functions
Function Details
default(string, TokenCredential | KeyCredential, ClientOptions)
function default(Endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): PersonalizerClientParameters
- Endpoint
-
string
- credentials
- options
- ClientOptions
Returns
isUnexpected(ServiceConfigurationUpdate200Response | ServiceConfigurationUpdatedefaultResponse)
function isUnexpected(response: ServiceConfigurationUpdate200Response | ServiceConfigurationUpdatedefaultResponse): responseParameters
Returns
response
isUnexpected(ServiceConfigurationApplyFromEvaluation204Response | ServiceConfigurationApplyFromEvaluationdefaultResponse)
function isUnexpected(response: ServiceConfigurationApplyFromEvaluation204Response | ServiceConfigurationApplyFromEvaluationdefaultResponse): responseParameters
Returns
response
isUnexpected(PolicyUpdate200Response | PolicyUpdatedefaultResponse)
function isUnexpected(response: PolicyUpdate200Response | PolicyUpdatedefaultResponse): responseParameters
Returns
response
isUnexpected(EvaluationsGet200Response | EvaluationsGetdefaultResponse)
function isUnexpected(response: EvaluationsGet200Response | EvaluationsGetdefaultResponse): responseParameters
Returns
response
isUnexpected(EvaluationsCreate201Response | EvaluationsCreatedefaultResponse)
function isUnexpected(response: EvaluationsCreate201Response | EvaluationsCreatedefaultResponse): responseParameters
Returns
response
isUnexpected(EventsReward204Response | EventsRewarddefaultResponse)
function isUnexpected(response: EventsReward204Response | EventsRewarddefaultResponse): responseParameters
Returns
response
isUnexpected(EventsActivate204Response | EventsActivatedefaultResponse)
function isUnexpected(response: EventsActivate204Response | EventsActivatedefaultResponse): responseParameters
Returns
response
isUnexpected(LogInteractions204Response | LogInteractionsdefaultResponse)
function isUnexpected(response: LogInteractions204Response | LogInteractionsdefaultResponse): responseParameters
Returns
response
isUnexpected(LogObservations204Response | LogObservationsdefaultResponse)
function isUnexpected(response: LogObservations204Response | LogObservationsdefaultResponse): responseParameters
Returns
response
isUnexpected(LogGetProperties200Response | LogGetPropertiesdefaultResponse)
function isUnexpected(response: LogGetProperties200Response | LogGetPropertiesdefaultResponse): responseParameters
Returns
response
isUnexpected(ModelGet200Response | ModelGetdefaultResponse)
function isUnexpected(response: ModelGet200Response | ModelGetdefaultResponse): responseParameters
- response
Returns
response
isUnexpected(ModelImport204Response | ModelImportdefaultResponse)
function isUnexpected(response: ModelImport204Response | ModelImportdefaultResponse): responseParameters
- response
Returns
response
isUnexpected(ModelReset204Response | ModelResetdefaultResponse)
function isUnexpected(response: ModelReset204Response | ModelResetdefaultResponse): responseParameters
- response
Returns
response
isUnexpected(MultiSlotEventsReward204Response | MultiSlotEventsRewarddefaultResponse)
function isUnexpected(response: MultiSlotEventsReward204Response | MultiSlotEventsRewarddefaultResponse): responseParameters
Returns
response
isUnexpected(MultiSlotEventsActivate204Response | MultiSlotEventsActivatedefaultResponse)
function isUnexpected(response: MultiSlotEventsActivate204Response | MultiSlotEventsActivatedefaultResponse): responseParameters
Returns
response
isUnexpected(MultiSlotRank201Response | MultiSlotRankdefaultResponse)
function isUnexpected(response: MultiSlotRank201Response | MultiSlotRankdefaultResponse): responseParameters
Returns
response
isUnexpected(Rank201Response | RankdefaultResponse)
function isUnexpected(response: Rank201Response | RankdefaultResponse): responseParameters
- response
Returns
response
