-
Notifications
You must be signed in to change notification settings - Fork 255
/
MagnitudeScoringParameters.xml
181 lines (181 loc) · 9.93 KB
/
MagnitudeScoringParameters.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<Type Name="MagnitudeScoringParameters" FullName="Microsoft.Azure.Search.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:Microsoft.Azure.Search.Models.MagnitudeScoringParameters" />
<TypeSignature Language="VB.NET" Value="Public Class MagnitudeScoringParameters" />
<TypeSignature Language="F#" Value="type MagnitudeScoringParameters = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.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 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the MagnitudeScoringParameters class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MagnitudeScoringParameters (double boostingRangeStart, double boostingRangeEnd, bool? shouldBoostBeyondRangeByConstant = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 boostingRangeStart, float64 boostingRangeEnd, valuetype System.Nullable`1<bool> shouldBoostBeyondRangeByConstant) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.#ctor(System.Double,System.Double,System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (boostingRangeStart As Double, boostingRangeEnd As Double, Optional shouldBoostBeyondRangeByConstant As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.MagnitudeScoringParameters : double * double * Nullable<bool> -> Microsoft.Azure.Search.Models.MagnitudeScoringParameters" Usage="new Microsoft.Azure.Search.Models.MagnitudeScoringParameters (boostingRangeStart, boostingRangeEnd, shouldBoostBeyondRangeByConstant)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="boostingRangeStart" Type="System.Double" />
<Parameter Name="boostingRangeEnd" Type="System.Double" />
<Parameter Name="shouldBoostBeyondRangeByConstant" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="boostingRangeStart">The field value at which boosting
starts.</param>
<param name="boostingRangeEnd">The field value at which boosting
ends.</param>
<param name="shouldBoostBeyondRangeByConstant">A value indicating
whether to apply a constant boost for field values beyond the range
end value; default is false.</param>
<summary>
Initializes a new instance of the MagnitudeScoringParameters class.
</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:Microsoft.Azure.Search.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="Microsoft.Azure.Search.Models.MagnitudeScoringParameters.BoostingRangeEnd" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="boostingRangeEnd")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="boostingRangeEnd")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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:Microsoft.Azure.Search.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="Microsoft.Azure.Search.Models.MagnitudeScoringParameters.BoostingRangeStart" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="boostingRangeStart")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="boostingRangeStart")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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<bool> ShouldBoostBeyondRangeByConstant" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.MagnitudeScoringParameters.ShouldBoostBeyondRangeByConstant" />
<MemberSignature Language="VB.NET" Value="Public Property ShouldBoostBeyondRangeByConstant As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.ShouldBoostBeyondRangeByConstant : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.MagnitudeScoringParameters.ShouldBoostBeyondRangeByConstant" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="constantBoostBeyondRange")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="constantBoostBeyondRange")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets 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>
<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.Search.Models.MagnitudeScoringParameters.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="magnitudeScoringParameters.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.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>