-
Notifications
You must be signed in to change notification settings - Fork 256
/
TagScoringFunction.xml
163 lines (163 loc) · 10.1 KB
/
TagScoringFunction.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
<Type Name="TagScoringFunction" FullName="Microsoft.Azure.Search.Models.TagScoringFunction">
<TypeSignature Language="C#" Value="public class TagScoringFunction : Microsoft.Azure.Search.Models.ScoringFunction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TagScoringFunction extends Microsoft.Azure.Search.Models.ScoringFunction" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.TagScoringFunction" />
<TypeSignature Language="VB.NET" Value="Public Class TagScoringFunction
Inherits ScoringFunction" />
<TypeSignature Language="F#" Value="type TagScoringFunction = class
 inherit ScoringFunction" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Search.Models.ScoringFunction</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("tag")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("tag")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Defines a function that boosts scores of documents with string values
matching a given list of tags.
<see href="https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TagScoringFunction ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TagScoringFunction.#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 TagScoringFunction class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TagScoringFunction (string fieldName, double boost, Microsoft.Azure.Search.Models.TagScoringParameters parameters, Microsoft.Azure.Search.Models.ScoringFunctionInterpolation? interpolation = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fieldName, float64 boost, class Microsoft.Azure.Search.Models.TagScoringParameters parameters, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.ScoringFunctionInterpolation> interpolation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TagScoringFunction.#ctor(System.String,System.Double,Microsoft.Azure.Search.Models.TagScoringParameters,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (fieldName As String, boost As Double, parameters As TagScoringParameters, Optional interpolation As Nullable(Of ScoringFunctionInterpolation) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.TagScoringFunction : string * double * Microsoft.Azure.Search.Models.TagScoringParameters * Nullable<Microsoft.Azure.Search.Models.ScoringFunctionInterpolation> -> Microsoft.Azure.Search.Models.TagScoringFunction" Usage="new Microsoft.Azure.Search.Models.TagScoringFunction (fieldName, boost, parameters, interpolation)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fieldName" Type="System.String" />
<Parameter Name="boost" Type="System.Double" />
<Parameter Name="parameters" Type="Microsoft.Azure.Search.Models.TagScoringParameters" />
<Parameter Name="interpolation" Type="System.Nullable<Microsoft.Azure.Search.Models.ScoringFunctionInterpolation>" />
</Parameters>
<Docs>
<param name="fieldName">The name of the field used as input to the
scoring function.</param>
<param name="boost">A multiplier for the raw score. Must be a
positive number not equal to 1.0.</param>
<param name="parameters">Parameter values for the tag scoring
function.</param>
<param name="interpolation">A value indicating how boosting will be
interpolated across document scores; defaults to "Linear". Possible
values include: 'linear', 'constant', 'quadratic',
'logarithmic'</param>
<summary>
Initializes a new instance of the TagScoringFunction class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TagScoringFunction (string fieldName, double boost, string tagsParameter, Microsoft.Azure.Search.Models.ScoringFunctionInterpolation? interpolation = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fieldName, float64 boost, string tagsParameter, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.ScoringFunctionInterpolation> interpolation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TagScoringFunction.#ctor(System.String,System.Double,System.String,System.Nullable{Microsoft.Azure.Search.Models.ScoringFunctionInterpolation})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (fieldName As String, boost As Double, tagsParameter As String, Optional interpolation As Nullable(Of ScoringFunctionInterpolation) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.TagScoringFunction : string * double * string * Nullable<Microsoft.Azure.Search.Models.ScoringFunctionInterpolation> -> Microsoft.Azure.Search.Models.TagScoringFunction" Usage="new Microsoft.Azure.Search.Models.TagScoringFunction (fieldName, boost, tagsParameter, interpolation)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fieldName" Type="System.String" />
<Parameter Name="boost" Type="System.Double" />
<Parameter Name="tagsParameter" Type="System.String" />
<Parameter Name="interpolation" Type="System.Nullable<Microsoft.Azure.Search.Models.ScoringFunctionInterpolation>" />
</Parameters>
<Docs>
<param name="fieldName">To be added.</param>
<param name="boost">To be added.</param>
<param name="tagsParameter">To be added.</param>
<param name="interpolation">To be added.</param>
<summary>
Initializes a new instance of the TagScoringFunction class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.TagScoringParameters Parameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Search.Models.TagScoringParameters Parameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.TagScoringFunction.Parameters" />
<MemberSignature Language="VB.NET" Value="Public Property Parameters As TagScoringParameters" />
<MemberSignature Language="F#" Value="member this.Parameters : Microsoft.Azure.Search.Models.TagScoringParameters with get, set" Usage="Microsoft.Azure.Search.Models.TagScoringFunction.Parameters" />
<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="tag")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="tag")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.TagScoringParameters</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets parameter values for the tag scoring function.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.TagScoringFunction.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="tagScoringFunction.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>