-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathConfigureOptionsSpeechToTextClient.xml
147 lines (147 loc) · 12 KB
/
ConfigureOptionsSpeechToTextClient.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
<Type Name="ConfigureOptionsSpeechToTextClient" FullName="Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient">
<TypeSignature Language="C#" Value="public sealed class ConfigureOptionsSpeechToTextClient : Microsoft.Extensions.AI.DelegatingSpeechToTextClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ConfigureOptionsSpeechToTextClient extends Microsoft.Extensions.AI.DelegatingSpeechToTextClient" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ConfigureOptionsSpeechToTextClient
Inherits DelegatingSpeechToTextClient" />
<TypeSignature Language="F#" Value="type ConfigureOptionsSpeechToTextClient = class
 inherit DelegatingSpeechToTextClient" />
<TypeSignature Language="C++ CLI" Value="public ref class ConfigureOptionsSpeechToTextClient sealed : Microsoft::Extensions::AI::DelegatingSpeechToTextClient" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Extensions.AI.DelegatingSpeechToTextClient</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.Experimental("MEAI001")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001")>]</AttributeName>
</Attribute>
<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>
<Docs>
<summary>Represents a delegating chat client that configures a <see cref="T:Microsoft.Extensions.AI.SpeechToTextOptions" /> instance used by the remainder of the pipeline.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConfigureOptionsSpeechToTextClient (Microsoft.Extensions.AI.ISpeechToTextClient innerClient, Action<Microsoft.Extensions.AI.SpeechToTextOptions> configure);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.ISpeechToTextClient innerClient, class System.Action`1<class Microsoft.Extensions.AI.SpeechToTextOptions> configure) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient.#ctor(Microsoft.Extensions.AI.ISpeechToTextClient,System.Action{Microsoft.Extensions.AI.SpeechToTextOptions})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (innerClient As ISpeechToTextClient, configure As Action(Of SpeechToTextOptions))" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient : Microsoft.Extensions.AI.ISpeechToTextClient * Action<Microsoft.Extensions.AI.SpeechToTextOptions> -> Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient" Usage="new Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient (innerClient, configure)" />
<MemberSignature Language="C++ CLI" Value="public:
 ConfigureOptionsSpeechToTextClient(Microsoft::Extensions::AI::ISpeechToTextClient ^ innerClient, Action<Microsoft::Extensions::AI::SpeechToTextOptions ^> ^ configure);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="innerClient" Type="Microsoft.Extensions.AI.ISpeechToTextClient" />
<Parameter Name="configure" Type="System.Action<Microsoft.Extensions.AI.SpeechToTextOptions>" />
</Parameters>
<Docs>
<param name="innerClient">The inner client.</param>
<param name="configure">
The delegate to invoke to configure the <see cref="T:Microsoft.Extensions.AI.SpeechToTextOptions" /> instance. It is passed a clone of the caller-supplied <see cref="T:Microsoft.Extensions.AI.SpeechToTextOptions" /> instance
(or a newly constructed instance if the caller-supplied instance is <see langword="null" />).
</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient" /> class with the specified <paramref name="configure" /> callback.</summary>
<remarks>
The <paramref name="configure" /> delegate is passed either a new instance of <see cref="T:Microsoft.Extensions.AI.SpeechToTextOptions" /> if
the caller didn't supply a <see cref="T:Microsoft.Extensions.AI.SpeechToTextOptions" /> instance, or a clone (via <see cref="M:Microsoft.Extensions.AI.SpeechToTextOptions.Clone" /> of the caller-supplied
instance if one was supplied.
</remarks>
</Docs>
</Member>
<Member MemberName="GetStreamingTextAsync">
<MemberSignature Language="C#" Value="public override System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.SpeechToTextResponseUpdate> GetStreamingTextAsync (System.IO.Stream audioSpeechStream, Microsoft.Extensions.AI.SpeechToTextOptions? options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Collections.Generic.IAsyncEnumerable`1<class Microsoft.Extensions.AI.SpeechToTextResponseUpdate> GetStreamingTextAsync(class System.IO.Stream audioSpeechStream, class Microsoft.Extensions.AI.SpeechToTextOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient.GetStreamingTextAsync(System.IO.Stream,Microsoft.Extensions.AI.SpeechToTextOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetStreamingTextAsync (audioSpeechStream As Stream, Optional options As SpeechToTextOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of SpeechToTextResponseUpdate)" />
<MemberSignature Language="F#" Value="override this.GetStreamingTextAsync : System.IO.Stream * Microsoft.Extensions.AI.SpeechToTextOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.SpeechToTextResponseUpdate>" Usage="configureOptionsSpeechToTextClient.GetStreamingTextAsync (audioSpeechStream, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient+<GetStreamingTextAsync>d__3))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient+<GetStreamingTextAsync>d__3))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.SpeechToTextResponseUpdate></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="audioSpeechStream" Type="System.IO.Stream" />
<Parameter Name="options" Type="Microsoft.Extensions.AI.SpeechToTextOptions">
<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">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.EnumeratorCancellation]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.EnumeratorCancellation>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="audioSpeechStream">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="GetTextAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.Task<Microsoft.Extensions.AI.SpeechToTextResponse> GetTextAsync (System.IO.Stream audioSpeechStream, Microsoft.Extensions.AI.SpeechToTextOptions? 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.SpeechToTextResponse> GetTextAsync(class System.IO.Stream audioSpeechStream, class Microsoft.Extensions.AI.SpeechToTextOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.ConfigureOptionsSpeechToTextClient.GetTextAsync(System.IO.Stream,Microsoft.Extensions.AI.SpeechToTextOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetTextAsync (audioSpeechStream As Stream, Optional options As SpeechToTextOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SpeechToTextResponse)" />
<MemberSignature Language="F#" Value="override this.GetTextAsync : System.IO.Stream * Microsoft.Extensions.AI.SpeechToTextOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.SpeechToTextResponse>" Usage="configureOptionsSpeechToTextClient.GetTextAsync (audioSpeechStream, 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.SpeechToTextResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="audioSpeechStream" Type="System.IO.Stream" />
<Parameter Name="options" Type="Microsoft.Extensions.AI.SpeechToTextOptions">
<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="audioSpeechStream">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>
</Members>
</Type>