RankRequest.xml

<Type Name="RankRequest" FullName="Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest">
  <TypeSignature Language="C#" Value="public class RankRequest" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RankRequest extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest" />
  <TypeSignature Language="VB.NET" Value="Public Class RankRequest" />
  <TypeSignature Language="F#" Value="type RankRequest = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
    <AssemblyVersion>0.8.0.0</AssemblyVersion>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Request a set of actions to be ranked by the Personalizer service.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RankRequest ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the RankRequest class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public RankRequest (System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt; actions, System.Collections.Generic.IList&lt;object&gt; contextFeatures = default, System.Collections.Generic.IList&lt;string&gt; excludedActions = default, string eventId = default, bool? deferActivation = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt; actions, class System.Collections.Generic.IList`1&lt;object&gt; contextFeatures, class System.Collections.Generic.IList`1&lt;string&gt; excludedActions, string eventId, valuetype System.Nullable`1&lt;bool&gt; deferActivation) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.#ctor(System.Collections.Generic.IList{Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction},System.Collections.Generic.IList{System.Object},System.Collections.Generic.IList{System.String},System.String,System.Nullable{System.Boolean})" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (actions As IList(Of RankableAction), Optional contextFeatures As IList(Of Object) = Nothing, Optional excludedActions As IList(Of String) = Nothing, Optional eventId As String = Nothing, Optional deferActivation As Nullable(Of Boolean) = Nothing)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest : System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt; * System.Collections.Generic.IList&lt;obj&gt; * System.Collections.Generic.IList&lt;string&gt; * string * Nullable&lt;bool&gt; -&gt; Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest" Usage="new Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest (actions, contextFeatures, excludedActions, eventId, deferActivation)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="actions" Type="System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt;" />
        <Parameter Name="contextFeatures" Type="System.Collections.Generic.IList&lt;System.Object&gt;" />
        <Parameter Name="excludedActions" Type="System.Collections.Generic.IList&lt;System.String&gt;" />
        <Parameter Name="eventId" Type="System.String" />
        <Parameter Name="deferActivation" Type="System.Nullable&lt;System.Boolean&gt;" />
      </Parameters>
      <Docs>
        <param name="actions">The set of actions the Personalizer service
            can pick from.
            The set should not contain more than 50 actions.
            The order of the actions does not affect the rank result but the
            order
            should match the sequence your application would have used to
            display them.</param>
        <param name="contextFeatures">Features of the context used for
            Personalizer as a
            dictionary of dictionaries. This depends on the application, and
            typically includes features about the current user, their
            device, profile information, data about time and date, etc.</param>
        <param name="excludedActions">The set of action ids to exclude from
            ranking.</param>
        <param name="eventId">Optionally pass an eventId that uniquely
            identifies this Rank event.
            If null, the service generates a unique eventId. The eventId will
            be used for
            associating this request with its reward, as well as seeding the
            pseudo-random
            generator when making a Personalizer call.</param>
        <param name="deferActivation">Send false if the user will see the
            rank results, therefore
            Personalizer will expect a Reward call, otherwise it will assign
            the default
            Reward to the event. Send true if it is possible the user will not
            see the
            rank results, because the page is rendering later, or the Rank
            results may be
            overridden by code further downstream.</param>
        <summary>
            Initializes a new instance of the RankRequest class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Actions">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt; Actions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt; Actions" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.Actions" />
      <MemberSignature Language="VB.NET" Value="Public Property Actions As IList(Of RankableAction)" />
      <MemberSignature Language="F#" Value="member this.Actions : System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt; with get, set" Usage="Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.Actions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="actions")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="actions")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Microsoft.Azure.CognitiveServices.Personalizer.Models.RankableAction&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the set of actions the Personalizer service can pick
            from.
            The set should not contain more than 50 actions.
            The order of the actions does not affect the rank result but the
            order
            should match the sequence your application would have used to
            display them.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ContextFeatures">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;object&gt; ContextFeatures { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;object&gt; ContextFeatures" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.ContextFeatures" />
      <MemberSignature Language="VB.NET" Value="Public Property ContextFeatures As IList(Of Object)" />
      <MemberSignature Language="F#" Value="member this.ContextFeatures : System.Collections.Generic.IList&lt;obj&gt; with get, set" Usage="Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.ContextFeatures" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="contextFeatures")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="contextFeatures")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.Object&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets features of the context used for Personalizer as a
            dictionary of dictionaries. This depends on the application, and
            typically includes features about the current user, their
            device, profile information, data about time and date, etc.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DeferActivation">
      <MemberSignature Language="C#" Value="public bool? DeferActivation { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; DeferActivation" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.DeferActivation" />
      <MemberSignature Language="VB.NET" Value="Public Property DeferActivation As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.DeferActivation : Nullable&lt;bool&gt; with get, set" Usage="Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.DeferActivation" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="deferActivation")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="deferActivation")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets send false if the user will see the rank results,
            therefore
            Personalizer will expect a Reward call, otherwise it will assign
            the default
            Reward to the event. Send true if it is possible the user will not
            see the
            rank results, because the page is rendering later, or the Rank
            results may be
            overridden by code further downstream.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EventId">
      <MemberSignature Language="C#" Value="public string EventId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string EventId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.EventId" />
      <MemberSignature Language="VB.NET" Value="Public Property EventId As String" />
      <MemberSignature Language="F#" Value="member this.EventId : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.EventId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="eventId")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="eventId")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets optionally pass an eventId that uniquely identifies
            this Rank event.
            If null, the service generates a unique eventId. The eventId will
            be used for
            associating this request with its reward, as well as seeding the
            pseudo-random
            generator when making a Personalizer call.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ExcludedActions">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; ExcludedActions { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; ExcludedActions" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.ExcludedActions" />
      <MemberSignature Language="VB.NET" Value="Public Property ExcludedActions As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.ExcludedActions : System.Collections.Generic.IList&lt;string&gt; with get, set" Usage="Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.ExcludedActions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="excludedActions")]</AttributeName>
          <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonProperty(PropertyName="excludedActions")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the set of action ids to exclude from ranking.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="public virtual void Validate ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Personalizer.Models.RankRequest.Validate" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
      <MemberSignature Language="F#" Value="abstract member Validate : unit -&gt; unit&#xA;override this.Validate : unit -&gt; unit" Usage="rankRequest.Validate " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.CognitiveServices.Personalizer</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Validate the object.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:Microsoft.Rest.ValidationException">
            Thrown if validation fails
            </exception>
      </Docs>
    </Member>
  </Members>
</Type>