-
Notifications
You must be signed in to change notification settings - Fork 261
/
HnswParameters.xml
119 lines (119 loc) · 7.13 KB
/
HnswParameters.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
<Type Name="HnswParameters" FullName="Azure.Search.Documents.Indexes.Models.HnswParameters">
<TypeSignature Language="C#" Value="public class HnswParameters" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HnswParameters extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.HnswParameters" />
<TypeSignature Language="VB.NET" Value="Public Class HnswParameters" />
<TypeSignature Language="F#" Value="type HnswParameters = class" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<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> Contains the parameters specific to the HNSW algorithm. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HnswParameters ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.HnswParameters.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.HnswParameters" />. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EfConstruction">
<MemberSignature Language="C#" Value="public int? EfConstruction { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> EfConstruction" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.HnswParameters.EfConstruction" />
<MemberSignature Language="VB.NET" Value="Public Property EfConstruction As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.EfConstruction : Nullable<int> with get, set" Usage="Azure.Search.Documents.Indexes.Models.HnswParameters.EfConstruction" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary> The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EfSearch">
<MemberSignature Language="C#" Value="public int? EfSearch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> EfSearch" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.HnswParameters.EfSearch" />
<MemberSignature Language="VB.NET" Value="Public Property EfSearch As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.EfSearch : Nullable<int> with get, set" Usage="Azure.Search.Documents.Indexes.Models.HnswParameters.EfSearch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary> The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="M">
<MemberSignature Language="C#" Value="public int? M { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> M" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.HnswParameters.M" />
<MemberSignature Language="VB.NET" Value="Public Property M As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.M : Nullable<int> with get, set" Usage="Azure.Search.Documents.Indexes.Models.HnswParameters.M" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary> The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Metric">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric? Metric { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric> Metric" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.HnswParameters.Metric" />
<MemberSignature Language="VB.NET" Value="Public Property Metric As Nullable(Of VectorSearchAlgorithmMetric)" />
<MemberSignature Language="F#" Value="member this.Metric : Nullable<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric> with get, set" Usage="Azure.Search.Documents.Indexes.Models.HnswParameters.Metric" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmMetric></ReturnType>
</ReturnValue>
<Docs>
<summary> The similarity metric to use for vector comparisons. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>