-
Notifications
You must be signed in to change notification settings - Fork 255
/
VectorSimilarityThreshold.xml
61 lines (61 loc) · 4.1 KB
/
VectorSimilarityThreshold.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
<Type Name="VectorSimilarityThreshold" FullName="Azure.Search.Documents.Models.VectorSimilarityThreshold">
<TypeSignature Language="C#" Value="public class VectorSimilarityThreshold : Azure.Search.Documents.Models.VectorThreshold" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VectorSimilarityThreshold extends Azure.Search.Documents.Models.VectorThreshold" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Models.VectorSimilarityThreshold" />
<TypeSignature Language="VB.NET" Value="Public Class VectorSimilarityThreshold
Inherits VectorThreshold" />
<TypeSignature Language="F#" Value="type VectorSimilarityThreshold = class
 inherit VectorThreshold" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Search.Documents.Models.VectorThreshold</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public VectorSimilarityThreshold (double value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 value) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Models.VectorSimilarityThreshold.#ctor(System.Double)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Double)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Models.VectorSimilarityThreshold : double -> Azure.Search.Documents.Models.VectorSimilarityThreshold" Usage="new Azure.Search.Documents.Models.VectorSimilarityThreshold value" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<param name="value"> The threshold will filter based on the similarity metric value. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. </param>
<summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Models.VectorSimilarityThreshold" />. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public double Value { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Value" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Models.VectorSimilarityThreshold.Value" />
<MemberSignature Language="VB.NET" Value="Public Property Value As Double" />
<MemberSignature Language="F#" Value="member this.Value : double with get, set" Usage="Azure.Search.Documents.Models.VectorSimilarityThreshold.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary> The threshold will filter based on the similarity metric value. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>