-
Notifications
You must be signed in to change notification settings - Fork 256
/
VectorSearch.xml
134 lines (134 loc) · 9.58 KB
/
VectorSearch.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
<Type Name="VectorSearch" FullName="Azure.Search.Documents.Indexes.Models.VectorSearch">
<TypeSignature Language="C#" Value="public class VectorSearch" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VectorSearch extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.VectorSearch" />
<TypeSignature Language="VB.NET" Value="Public Class VectorSearch" />
<TypeSignature Language="F#" Value="type VectorSearch = 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 configuration options related to vector search. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public VectorSearch ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.VectorSearch.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.VectorSearch" />. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Algorithms">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration> Algorithms { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration> Algorithms" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.VectorSearch.Algorithms" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Algorithms As IList(Of VectorSearchAlgorithmConfiguration)" />
<MemberSignature Language="F#" Value="member this.Algorithms : System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration>" Usage="Azure.Search.Documents.Indexes.Models.VectorSearch.Algorithms" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration></ReturnType>
</ReturnValue>
<Docs>
<summary>
Contains configuration options specific to the algorithm used during indexing or querying.
Please note <see cref="T:Azure.Search.Documents.Indexes.Models.VectorSearchAlgorithmConfiguration" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.Search.Documents.Indexes.Models.ExhaustiveKnnAlgorithmConfiguration" /> and <see cref="T:Azure.Search.Documents.Indexes.Models.HnswAlgorithmConfiguration" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Compressions">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchCompressionConfiguration> Compressions { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Azure.Search.Documents.Indexes.Models.VectorSearchCompressionConfiguration> Compressions" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.VectorSearch.Compressions" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Compressions As IList(Of VectorSearchCompressionConfiguration)" />
<MemberSignature Language="F#" Value="member this.Compressions : System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchCompressionConfiguration>" Usage="Azure.Search.Documents.Indexes.Models.VectorSearch.Compressions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchCompressionConfiguration></ReturnType>
</ReturnValue>
<Docs>
<summary>
Contains configuration options specific to the compression method used during indexing or querying.
Please note <see cref="T:Azure.Search.Documents.Indexes.Models.VectorSearchCompressionConfiguration" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.Search.Documents.Indexes.Models.ScalarQuantizationCompressionConfiguration" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Profiles">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchProfile> Profiles { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Azure.Search.Documents.Indexes.Models.VectorSearchProfile> Profiles" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.VectorSearch.Profiles" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Profiles As IList(Of VectorSearchProfile)" />
<MemberSignature Language="F#" Value="member this.Profiles : System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchProfile>" Usage="Azure.Search.Documents.Indexes.Models.VectorSearch.Profiles" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchProfile></ReturnType>
</ReturnValue>
<Docs>
<summary> Defines combinations of configurations to use with vector search. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Vectorizers">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchVectorizer> Vectorizers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Azure.Search.Documents.Indexes.Models.VectorSearchVectorizer> Vectorizers" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.VectorSearch.Vectorizers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Vectorizers As IList(Of VectorSearchVectorizer)" />
<MemberSignature Language="F#" Value="member this.Vectorizers : System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchVectorizer>" Usage="Azure.Search.Documents.Indexes.Models.VectorSearch.Vectorizers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.VectorSearchVectorizer></ReturnType>
</ReturnValue>
<Docs>
<summary>
Contains configuration options on how to vectorize text vector queries.
Please note <see cref="T:Azure.Search.Documents.Indexes.Models.VectorSearchVectorizer" /> is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes.
The available derived classes include <see cref="T:Azure.Search.Documents.Indexes.Models.AIServicesVisionVectorizer" />, <see cref="T:Azure.Search.Documents.Indexes.Models.AzureMachineLearningVectorizer" />, <see cref="T:Azure.Search.Documents.Indexes.Models.AzureOpenAIVectorizer" /> and <see cref="T:Azure.Search.Documents.Indexes.Models.CustomVectorizer" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>