RankRequest クラス
Personalizer サービスによってランク付けされる一連のアクションを要求します。
Azure に送信するには、必要なすべてのパラメーターを設定する必要があります。
- 継承
-
RankRequest
コンストラクター
RankRequest(*, actions, context_features=None, excluded_actions=None, event_id: str = None, defer_activation: bool = False, **kwargs)
パラメーター
辞書の辞書として Personalizer に使用されるコンテキストの機能。 これはアプリケーションによって異なり、通常は現在のユーザー、デバイス、プロファイル情報、時刻と日付に関するデータに関する機能が含まれます。
- actions
- list[RankableAction]
必須。 Personalizer サービスが選択できる一連のアクション。 セットには、50 個を超えるアクションを含めてはなりません。 アクションの順序はランクの結果には影響しませんが、順序は、アプリケーションがそれらを表示するために使用したシーケンスと一致する必要があります。
- event_id
- str
必要に応じて、この Rank イベントを一意に識別する eventId を渡します。 null の場合、サービスは一意の eventId を生成します。 eventId は、この要求を報酬に関連付けるだけでなく、Personalizer 呼び出しを行うときに擬似ランダム ジェネレーターをシード処理するために使用されます。
- defer_activation
- bool
ユーザーにランク結果が表示される場合は false を送信します。したがって、Personalizer は Reward 呼び出しを期待します。それ以外の場合は、既定の Reward がイベントに割り当てられます。 ページが後でレンダリングされるか、ランクの結果がさらに下流のコードによってオーバーライドされる可能性があるため、ユーザーにランク結果が表示されない可能性がある場合は true を送信します。 既定値: False。
メソッド
as_dict |
json.dump を使用して JSONify できる dict を返します。 高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。 キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。 返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。 このファイルの 3 つの例を参照してください。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
deserialize |
RestAPI 構文を使用して str を解析し、モデルを返します。 |
enable_additional_properties_sending | |
from_dict |
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。 既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください |
is_xml_model | |
serialize |
このモデルから Azure に送信される JSON を返します。 これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。 XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。 |
validate |
このモデルを再帰的に検証し、ValidationError の一覧を返します。 |
as_dict
json.dump を使用して JSONify できる dict を返します。
高度な使用法では、必要に応じてコールバックをパラメーターとして使用できます。
キーは、Python で使用される属性名です。 Attr_descはメタデータのディクテーションです。 現在、msrest 型の 'type' と RestAPI でエンコードされたキーを持つ 'key' が含まれています。 値は、このオブジェクトの現在の値です。
返される文字列は、キーのシリアル化に使用されます。 戻り値の型がリストの場合、これは階層的な結果のディクトと見なされます。
このファイルの 3 つの例を参照してください。
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
パラメーター
- key_transformer
- <xref:function>
キー トランスフォーマー関数。
- keep_readonly
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
deserialize
RestAPI 構文を使用して str を解析し、モデルを返します。
deserialize(data, content_type=None)
パラメーター
戻り値
このモデルのインスタンス
例外
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
指定されたキー抽出器を使用してディクテーションを解析し、モデルを返します。
既定では、キー抽出器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor、last_rest_key_case_insensitive_extractor) を検討してください
from_dict(data, key_extractors=None, content_type=None)
パラメーター
- key_extractors
戻り値
このモデルのインスタンス
例外
is_xml_model
is_xml_model()
serialize
このモデルから Azure に送信される JSON を返します。
これは、 as_dict(full_restapi_key_transformer、keep_readonly=False) のエイリアスです。
XML シリアル化が必要な場合は、kwargs is_xml=True を渡すことができます。
serialize(keep_readonly=False, **kwargs)
パラメーター
戻り値
dict JSON 互換オブジェクト
の戻り値の型 :
validate
Azure SDK for Python