-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathCachingEmbeddingGenerator`2.xml
217 lines (217 loc) · 16.7 KB
/
CachingEmbeddingGenerator`2.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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<Type Name="CachingEmbeddingGenerator<TInput,TEmbedding>" FullName="Microsoft.Extensions.AI.CachingEmbeddingGenerator<TInput,TEmbedding>">
<TypeSignature Language="C#" Value="public abstract class CachingEmbeddingGenerator<TInput,TEmbedding> : Microsoft.Extensions.AI.DelegatingEmbeddingGenerator<TInput,TEmbedding> where TEmbedding : Embedding" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit CachingEmbeddingGenerator`2<TInput, (class Microsoft.Extensions.AI.Embedding) TEmbedding> extends Microsoft.Extensions.AI.DelegatingEmbeddingGenerator`2<!TInput, !TEmbedding>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class CachingEmbeddingGenerator(Of TInput, TEmbedding)
Inherits DelegatingEmbeddingGenerator(Of TInput, TEmbedding)" />
<TypeSignature Language="F#" Value="type CachingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Embedding)> = class
 inherit DelegatingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Embedding)>" />
<TypeSignature Language="C++ CLI" Value="generic <typename TInput, typename TEmbedding>
 where TEmbedding : Embeddingpublic ref class CachingEmbeddingGenerator abstract : Microsoft::Extensions::AI::DelegatingEmbeddingGenerator<TInput, TEmbedding>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>9.1.0.0</AssemblyVersion>
<AssemblyVersion>9.3.0.0</AssemblyVersion>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TInput">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
<TypeParameter Name="TEmbedding">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
<Constraints>
<BaseTypeName>Microsoft.Extensions.AI.Embedding</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>Microsoft.Extensions.AI.DelegatingEmbeddingGenerator<TInput,TEmbedding></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="!0">TInput</BaseTypeArgument>
<BaseTypeArgument TypeParamName="!1">TEmbedding</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TInput">The type from which embeddings will be generated.</typeparam>
<typeparam name="TEmbedding">The type of embeddings to generate.</typeparam>
<summary>Represents a delegating embedding generator that caches the results of embedding generation calls.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CachingEmbeddingGenerator (Microsoft.Extensions.AI.IEmbeddingGenerator<TInput,TEmbedding> innerGenerator);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.IEmbeddingGenerator`2<!TInput, !TEmbedding> innerGenerator) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2.#ctor(Microsoft.Extensions.AI.IEmbeddingGenerator{`0,`1})" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (innerGenerator As IEmbeddingGenerator(Of TInput, TEmbedding))" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.CachingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)> : Microsoft.Extensions.AI.IEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)> -> Microsoft.Extensions.AI.CachingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)>" Usage="new Microsoft.Extensions.AI.CachingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)> innerGenerator" />
<MemberSignature Language="C++ CLI" Value="protected:
 CachingEmbeddingGenerator(Microsoft::Extensions::AI::IEmbeddingGenerator<TInput, TEmbedding> ^ innerGenerator);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="innerGenerator" Type="Microsoft.Extensions.AI.IEmbeddingGenerator<TInput,TEmbedding>" />
</Parameters>
<Docs>
<param name="innerGenerator">The underlying <see cref="T:Microsoft.Extensions.AI.IEmbeddingGenerator`2" />.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task<Microsoft.Extensions.AI.GeneratedEmbeddings<TEmbedding>> GenerateAsync (System.Collections.Generic.IEnumerable<TInput> values, Microsoft.Extensions.AI.EmbeddingGenerationOptions? options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.GeneratedEmbeddings`1<!TEmbedding>> GenerateAsync(class System.Collections.Generic.IEnumerable`1<!TInput> values, class Microsoft.Extensions.AI.EmbeddingGenerationOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2.GenerateAsync(System.Collections.Generic.IEnumerable{`0},Microsoft.Extensions.AI.EmbeddingGenerationOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GenerateAsync (values As IEnumerable(Of TInput), Optional options As EmbeddingGenerationOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of GeneratedEmbeddings(Of TEmbedding))" />
<MemberSignature Language="F#" Value="override this.GenerateAsync : seq<'Input> * Microsoft.Extensions.AI.EmbeddingGenerationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.GeneratedEmbeddings<'Embedding>>" Usage="cachingEmbeddingGenerator.GenerateAsync (values, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Extensions.AI.GeneratedEmbeddings<TEmbedding>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="values" Type="System.Collections.Generic.IEnumerable<TInput>" />
<Parameter Name="options" Type="Microsoft.Extensions.AI.EmbeddingGenerationOptions">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="values">To be added.</param>
<param name="options">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetCacheKey">
<MemberSignature Language="C#" Value="protected abstract string GetCacheKey (scoped ReadOnlySpan<object?> values);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string GetCacheKey(valuetype System.ReadOnlySpan`1<object> values) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2.GetCacheKey(System.ReadOnlySpan{System.Object})" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function GetCacheKey (values As ReadOnlySpan(Of Object)) As String" />
<MemberSignature Language="F#" Value="abstract member GetCacheKey : ReadOnlySpan<obj> -> string" Usage="cachingEmbeddingGenerator.GetCacheKey values" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::String ^ GetCacheKey(ReadOnlySpan<System::Object ^> values);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="values" Type="System.ReadOnlySpan<System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 2 })>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-10.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.ParamCollection]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.ParamCollection>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.ScopedRef]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.ScopedRef>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="values">The values to inform the key.</param>
<summary>Computes a cache key for the specified values.</summary>
<returns>The computed key.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadCacheAsync">
<MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task<TEmbedding?> ReadCacheAsync (string key, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!TEmbedding> ReadCacheAsync(string key, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2.ReadCacheAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function ReadCacheAsync (key As String, cancellationToken As CancellationToken) As Task(Of TEmbedding)" />
<MemberSignature Language="F#" Value="abstract member ReadCacheAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)>" Usage="cachingEmbeddingGenerator.ReadCacheAsync (key, cancellationToken)" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::Threading::Tasks::Task<TEmbedding> ^ ReadCacheAsync(System::String ^ key, System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TEmbedding></ReturnType>
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="key">The cache key.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.</param>
<summary>Returns a previously cached <see cref="T:Microsoft.Extensions.AI.Embedding`1" />, if available.</summary>
<returns>The previously cached data, if available, otherwise <see langword="null" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WriteCacheAsync">
<MemberSignature Language="C#" Value="protected abstract System.Threading.Tasks.Task WriteCacheAsync (string key, TEmbedding value, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task WriteCacheAsync(string key, !TEmbedding value, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.CachingEmbeddingGenerator`2.WriteCacheAsync(System.String,`1,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function WriteCacheAsync (key As String, value As TEmbedding, cancellationToken As CancellationToken) As Task" />
<MemberSignature Language="F#" Value="abstract member WriteCacheAsync : string * 'Embedding * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="cachingEmbeddingGenerator.WriteCacheAsync (key, value, cancellationToken)" />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::Threading::Tasks::Task ^ WriteCacheAsync(System::String ^ key, TEmbedding value, System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="TEmbedding" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="key">The cache key.</param>
<param name="value">The <typeparamref name="TEmbedding" /> to be stored.</param>
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests.</param>
<summary>Stores a <typeparamref name="TEmbedding" /> in the underlying cache.</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task" /> representing the completion of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>