-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathOpenAIClientExtensions.xml
213 lines (213 loc) · 16.9 KB
/
OpenAIClientExtensions.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
<Type Name="OpenAIClientExtensions" FullName="Microsoft.Extensions.AI.OpenAIClientExtensions">
<TypeSignature Language="C#" Value="public static class OpenAIClientExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit OpenAIClientExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.AI.OpenAIClientExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module OpenAIClientExtensions" />
<TypeSignature Language="F#" Value="type OpenAIClientExtensions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class OpenAIClientExtensions abstract sealed" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<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>
<Docs>
<summary>Provides extension methods for working with <see cref="T:OpenAI.OpenAIClient" />s.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AsChatClient">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.IChatClient AsChatClient (this OpenAI.OpenAIClient openAIClient, string modelId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.IChatClient AsChatClient(class OpenAI.OpenAIClient openAIClient, string modelId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.OpenAIClientExtensions.AsChatClient(OpenAI.OpenAIClient,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AsChatClient (openAIClient As OpenAIClient, modelId As String) As IChatClient" />
<MemberSignature Language="F#" Value="static member AsChatClient : OpenAI.OpenAIClient * string -> Microsoft.Extensions.AI.IChatClient" Usage="Microsoft.Extensions.AI.OpenAIClientExtensions.AsChatClient (openAIClient, modelId)" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::IChatClient ^ AsChatClient(OpenAI::OpenAIClient ^ openAIClient, System::String ^ modelId);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This method will be removed in an upcoming release.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This method will be removed in an upcoming release.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.IChatClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="openAIClient" Type="OpenAI.OpenAIClient" RefType="this" />
<Parameter Name="modelId" Type="System.String" />
</Parameters>
<Docs>
<param name="openAIClient">The client.</param>
<param name="modelId">The model.</param>
<summary>Gets an <see cref="T:Microsoft.Extensions.AI.IChatClient" /> for use with this <see cref="T:OpenAI.OpenAIClient" />.</summary>
<returns>An <see cref="T:Microsoft.Extensions.AI.IChatClient" /> that can be used to converse via the <see cref="T:OpenAI.OpenAIClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AsEmbeddingGenerator">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.IEmbeddingGenerator<string,Microsoft.Extensions.AI.Embedding<float>> AsEmbeddingGenerator (this OpenAI.OpenAIClient openAIClient, string modelId, int? dimensions = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.IEmbeddingGenerator`2<string, class Microsoft.Extensions.AI.Embedding`1<float32>> AsEmbeddingGenerator(class OpenAI.OpenAIClient openAIClient, string modelId, valuetype System.Nullable`1<int32> dimensions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.OpenAIClientExtensions.AsEmbeddingGenerator(OpenAI.OpenAIClient,System.String,System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AsEmbeddingGenerator (openAIClient As OpenAIClient, modelId As String, Optional dimensions As Nullable(Of Integer) = Nothing) As IEmbeddingGenerator(Of String, Embedding(Of Single))" />
<MemberSignature Language="F#" Value="static member AsEmbeddingGenerator : OpenAI.OpenAIClient * string * Nullable<int> -> Microsoft.Extensions.AI.IEmbeddingGenerator<string, Microsoft.Extensions.AI.Embedding<single>>" Usage="Microsoft.Extensions.AI.OpenAIClientExtensions.AsEmbeddingGenerator (openAIClient, modelId, dimensions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("This method will be removed in an upcoming release.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This method will be removed in an upcoming release.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.IEmbeddingGenerator<System.String,Microsoft.Extensions.AI.Embedding<System.Single>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="openAIClient" Type="OpenAI.OpenAIClient" RefType="this" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="dimensions" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="openAIClient">The client.</param>
<param name="modelId">The model to use.</param>
<param name="dimensions">The number of dimensions to generate in each embedding.</param>
<summary>Gets an <see cref="T:Microsoft.Extensions.AI.IEmbeddingGenerator`2" /> for use with this <see cref="T:OpenAI.OpenAIClient" />.</summary>
<returns>An <see cref="T:Microsoft.Extensions.AI.IEmbeddingGenerator`2" /> that can be used to generate embeddings via the <see cref="T:OpenAI.Embeddings.EmbeddingClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AsIChatClient">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.IChatClient AsIChatClient (this OpenAI.Chat.ChatClient chatClient);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.IChatClient AsIChatClient(class OpenAI.Chat.ChatClient chatClient) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.OpenAIClientExtensions.AsIChatClient(OpenAI.Chat.ChatClient)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AsIChatClient (chatClient As ChatClient) As IChatClient" />
<MemberSignature Language="F#" Value="static member AsIChatClient : OpenAI.Chat.ChatClient -> Microsoft.Extensions.AI.IChatClient" Usage="Microsoft.Extensions.AI.OpenAIClientExtensions.AsIChatClient chatClient" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::IChatClient ^ AsIChatClient(OpenAI::Chat::ChatClient ^ chatClient);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.IChatClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="chatClient" Type="OpenAI.Chat.ChatClient" RefType="this" />
</Parameters>
<Docs>
<param name="chatClient">The client.</param>
<summary>Gets an <see cref="T:Microsoft.Extensions.AI.IChatClient" /> for use with this <see cref="T:OpenAI.Chat.ChatClient" />.</summary>
<returns>An <see cref="T:Microsoft.Extensions.AI.IChatClient" /> that can be used to converse via the <see cref="T:OpenAI.Chat.ChatClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AsIChatClient">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.IChatClient AsIChatClient (this OpenAI.Responses.OpenAIResponseClient responseClient);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.IChatClient AsIChatClient(class OpenAI.Responses.OpenAIResponseClient responseClient) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.OpenAIClientExtensions.AsIChatClient(OpenAI.Responses.OpenAIResponseClient)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AsIChatClient (responseClient As OpenAIResponseClient) As IChatClient" />
<MemberSignature Language="F#" Value="static member AsIChatClient : OpenAI.Responses.OpenAIResponseClient -> Microsoft.Extensions.AI.IChatClient" Usage="Microsoft.Extensions.AI.OpenAIClientExtensions.AsIChatClient responseClient" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::IChatClient ^ AsIChatClient(OpenAI::Responses::OpenAIResponseClient ^ responseClient);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.IChatClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="responseClient" Type="OpenAI.Responses.OpenAIResponseClient" RefType="this" />
</Parameters>
<Docs>
<param name="responseClient">The client.</param>
<summary>Gets an <see cref="T:Microsoft.Extensions.AI.IChatClient" /> for use with this <see cref="T:OpenAI.Responses.OpenAIResponseClient" />.</summary>
<returns>An <see cref="T:Microsoft.Extensions.AI.IChatClient" /> that can be used to converse via the <see cref="T:OpenAI.Responses.OpenAIResponseClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AsIEmbeddingGenerator">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.IEmbeddingGenerator<string,Microsoft.Extensions.AI.Embedding<float>> AsIEmbeddingGenerator (this OpenAI.Embeddings.EmbeddingClient embeddingClient, int? defaultModelDimensions = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.IEmbeddingGenerator`2<string, class Microsoft.Extensions.AI.Embedding`1<float32>> AsIEmbeddingGenerator(class OpenAI.Embeddings.EmbeddingClient embeddingClient, valuetype System.Nullable`1<int32> defaultModelDimensions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.OpenAIClientExtensions.AsIEmbeddingGenerator(OpenAI.Embeddings.EmbeddingClient,System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AsIEmbeddingGenerator (embeddingClient As EmbeddingClient, Optional defaultModelDimensions As Nullable(Of Integer) = Nothing) As IEmbeddingGenerator(Of String, Embedding(Of Single))" />
<MemberSignature Language="F#" Value="static member AsIEmbeddingGenerator : OpenAI.Embeddings.EmbeddingClient * Nullable<int> -> Microsoft.Extensions.AI.IEmbeddingGenerator<string, Microsoft.Extensions.AI.Embedding<single>>" Usage="Microsoft.Extensions.AI.OpenAIClientExtensions.AsIEmbeddingGenerator (embeddingClient, defaultModelDimensions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.IEmbeddingGenerator<System.String,Microsoft.Extensions.AI.Embedding<System.Single>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="embeddingClient" Type="OpenAI.Embeddings.EmbeddingClient" RefType="this" />
<Parameter Name="defaultModelDimensions" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="embeddingClient">The client.</param>
<param name="defaultModelDimensions">The number of dimensions to generate in each embedding.</param>
<summary>Gets an <see cref="T:Microsoft.Extensions.AI.IEmbeddingGenerator`2" /> for use with this <see cref="T:OpenAI.Embeddings.EmbeddingClient" />.</summary>
<returns>An <see cref="T:Microsoft.Extensions.AI.IEmbeddingGenerator`2" /> that can be used to generate embeddings via the <see cref="T:OpenAI.Embeddings.EmbeddingClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AsISpeechToTextClient">
<MemberSignature Language="C#" Value="public static Microsoft.Extensions.AI.ISpeechToTextClient AsISpeechToTextClient (this OpenAI.Audio.AudioClient audioClient);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Extensions.AI.ISpeechToTextClient AsISpeechToTextClient(class OpenAI.Audio.AudioClient audioClient) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.AI.OpenAIClientExtensions.AsISpeechToTextClient(OpenAI.Audio.AudioClient)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AsISpeechToTextClient (audioClient As AudioClient) As ISpeechToTextClient" />
<MemberSignature Language="F#" Value="static member AsISpeechToTextClient : OpenAI.Audio.AudioClient -> Microsoft.Extensions.AI.ISpeechToTextClient" Usage="Microsoft.Extensions.AI.OpenAIClientExtensions.AsISpeechToTextClient audioClient" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::ISpeechToTextClient ^ AsISpeechToTextClient(OpenAI::Audio::AudioClient ^ audioClient);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI.OpenAI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Extensions.AI.ISpeechToTextClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="audioClient" Type="OpenAI.Audio.AudioClient" RefType="this" />
</Parameters>
<Docs>
<param name="audioClient">The client.</param>
<summary>Gets an <see cref="T:Microsoft.Extensions.AI.ISpeechToTextClient" /> for use with this <see cref="T:OpenAI.Audio.AudioClient" />.</summary>
<returns>An <see cref="T:Microsoft.Extensions.AI.ISpeechToTextClient" /> that can be used to transcribe audio via the <see cref="T:OpenAI.Audio.AudioClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>