RankRequest 類別
要求個人化工具服務排名的一組動作。
必須填入所有必要的參數,才能傳送至 Azure。
- 繼承
-
RankRequest
建構函式
RankRequest(*, actions, context_features=None, excluded_actions=None, event_id: str = None, defer_activation: bool = False, **kwargs)
參數
- actions
- list[RankableAction]
必要。 個人化工具服務可以挑選的一組動作。 集合不應包含超過 50 個動作。 動作的順序不會影響排名結果,但順序應該符合您的應用程式用來顯示順序的順序。
- event_id
- str
選擇性地傳遞可唯一識別此 Rank 事件的 eventId。 如果為 null,服務會產生唯一的 eventId。 eventId 將用於將此要求與其獎勵產生關聯,以及在進行個人化工具呼叫時植入虛擬隨機產生器。
- defer_activation
- bool
如果使用者會看到排名結果,則傳送 false,因此個人化工具會預期獎勵呼叫,否則會將預設獎勵指派給事件。 如果使用者可能看不到排名結果,則傳送 true,因為頁面稍後正在轉譯,或者排名結果可能會由程式碼進一步下游覆寫。 預設值:False 。
方法
as_dict |
使用 json.dump 傳回可以是 JSONify 的聽寫。 進階用法可以選擇性地使用回呼作為參數: 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例:
如果您想要 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 的聽寫。
進階用法可以選擇性地使用回呼作為參數:
索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type',以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。
傳回的字串將用來序列化索引鍵。 如果傳回類型是清單,則會將此視為階層式結果聽寫。
請參閱此檔案中的三個範例:
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
傳回
與聽寫 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)
參數
傳回
與聽寫 JSON 相容的物件
傳回類型
validate
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應