EventsOperations Class

EventsOperations operations.

Inheritance

builtins.object

EventsOperations

Constructor

EventsOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Methods

activate	Report that the specified event was actually displayed to the user and a reward should be expected for it.
reward	Report reward to allocate to the top ranked action for the specified event.

activate

Report that the specified event was actually displayed to the user and a reward should be expected for it.

activate(event_id, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
event_id Required	str The event ID this activation applies to.
custom_headers	dict headers that will be added to the request default value: None
raw	bool returns the direct response alongside the deserialized response default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
None, <xref:msrest.pipeline.ClientRawResponse>	None or ClientRawResponse if raw=true

Exceptions

Type	Description
msrest.exceptions.HttpOperationError

reward

Report reward to allocate to the top ranked action for the specified event.

reward(event_id, value, custom_headers=None, raw=False, **operation_config)

Parameters

Name	Description
event_id Required	str The event id this reward applies to.
value Required	float Reward to be assigned to an action. Value should be between -1 and 1 inclusive.
custom_headers	dict headers that will be added to the request default value: None
raw	bool returns the direct response alongside the deserialized response default value: False
operation_config Required	Operation configuration overrides.

Returns

Type	Description
None, <xref:msrest.pipeline.ClientRawResponse>	None or ClientRawResponse if raw=true

Exceptions

Type	Description
msrest.exceptions.HttpOperationError

Attributes

models

models = <module 'azure.cognitiveservices.personalizer.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\personalizer\\models\\__init__.py'>