-
Notifications
You must be signed in to change notification settings - Fork 256
/
FreshnessScoringFunction.xml
75 lines (75 loc) · 5.15 KB
/
FreshnessScoringFunction.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
<Type Name="FreshnessScoringFunction" FullName="Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction">
<TypeSignature Language="C#" Value="public class FreshnessScoringFunction : Azure.Search.Documents.Indexes.Models.ScoringFunction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FreshnessScoringFunction extends Azure.Search.Documents.Indexes.Models.ScoringFunction" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction" />
<TypeSignature Language="VB.NET" Value="Public Class FreshnessScoringFunction
Inherits ScoringFunction" />
<TypeSignature Language="F#" Value="type FreshnessScoringFunction = class
 inherit ScoringFunction" />
<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>Azure.Search.Documents.Indexes.Models.ScoringFunction</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Defines a function that boosts scores based on the value of a date-time field. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FreshnessScoringFunction (string fieldName, double boost, Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters parameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string fieldName, float64 boost, class Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction.#ctor(System.String,System.Double,Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (fieldName As String, boost As Double, parameters As FreshnessScoringParameters)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction : string * double * Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters -> Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction" Usage="new Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction (fieldName, boost, parameters)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fieldName" Type="System.String" />
<Parameter Name="boost" Type="System.Double" />
<Parameter Name="parameters" Type="Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters" />
</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 freshness scoring function. </param>
<summary> Initializes a new instance of FreshnessScoringFunction. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="fieldName" /> is an empty string.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="fieldName" /> or <paramref name="parameters" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters Parameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters Parameters" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction.Parameters" />
<MemberSignature Language="VB.NET" Value="Public Property Parameters As FreshnessScoringParameters" />
<MemberSignature Language="F#" Value="member this.Parameters : Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters with get, set" Usage="Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction.Parameters" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Search.Documents.Indexes.Models.FreshnessScoringParameters</ReturnType>
</ReturnValue>
<Docs>
<summary> Parameter values for the freshness scoring function. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>