MagnitudeScoringParameters.xml

<Type Name="MagnitudeScoringParameters" FullName="Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters">
  <TypeSignature Language="C#" Value="public class MagnitudeScoringParameters" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MagnitudeScoringParameters extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters" />
  <TypeSignature Language="VB.NET" Value="Public Class MagnitudeScoringParameters" />
  <TypeSignature Language="F#" Value="type MagnitudeScoringParameters = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Search.Documents</AssemblyName>
    <AssemblyVersion>11.2.0.0</AssemblyVersion>
    <AssemblyVersion>11.2.1.0</AssemblyVersion>
    <AssemblyVersion>11.3.0.0</AssemblyVersion>
    <AssemblyVersion>11.4.0.0</AssemblyVersion>
    <AssemblyVersion>11.5.0.0</AssemblyVersion>
    <AssemblyVersion>11.5.1.0</AssemblyVersion>
    <AssemblyVersion>11.6.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary> Provides parameter values to a magnitude scoring function. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MagnitudeScoringParameters (double boostingRangeStart, double boostingRangeEnd);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 boostingRangeStart, float64 boostingRangeEnd) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.#ctor(System.Double,System.Double)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (boostingRangeStart As Double, boostingRangeEnd As Double)" />
      <MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters : double * double -&gt; Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters" Usage="new Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters (boostingRangeStart, boostingRangeEnd)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="boostingRangeStart" Type="System.Double" />
        <Parameter Name="boostingRangeEnd" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="boostingRangeStart"> The field value at which boosting starts. </param>
        <param name="boostingRangeEnd"> The field value at which boosting ends. </param>
        <summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters" />. </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BoostingRangeEnd">
      <MemberSignature Language="C#" Value="public double BoostingRangeEnd { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 BoostingRangeEnd" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.BoostingRangeEnd" />
      <MemberSignature Language="VB.NET" Value="Public Property BoostingRangeEnd As Double" />
      <MemberSignature Language="F#" Value="member this.BoostingRangeEnd : double with get, set" Usage="Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.BoostingRangeEnd" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The field value at which boosting ends. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BoostingRangeStart">
      <MemberSignature Language="C#" Value="public double BoostingRangeStart { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance float64 BoostingRangeStart" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.BoostingRangeStart" />
      <MemberSignature Language="VB.NET" Value="Public Property BoostingRangeStart As Double" />
      <MemberSignature Language="F#" Value="member this.BoostingRangeStart : double with get, set" Usage="Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.BoostingRangeStart" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The field value at which boosting starts. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ShouldBoostBeyondRangeByConstant">
      <MemberSignature Language="C#" Value="public bool? ShouldBoostBeyondRangeByConstant { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1&lt;bool&gt; ShouldBoostBeyondRangeByConstant" />
      <MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.ShouldBoostBeyondRangeByConstant" />
      <MemberSignature Language="VB.NET" Value="Public Property ShouldBoostBeyondRangeByConstant As Nullable(Of Boolean)" />
      <MemberSignature Language="F#" Value="member this.ShouldBoostBeyondRangeByConstant : Nullable&lt;bool&gt; with get, set" Usage="Azure.Search.Documents.Indexes.Models.MagnitudeScoringParameters.ShouldBoostBeyondRangeByConstant" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Search.Documents</AssemblyName>
        <AssemblyVersion>11.5.1.0</AssemblyVersion>
        <AssemblyVersion>11.6.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> A value indicating whether to apply a constant boost for field values beyond the range end value; default is false. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>