- Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathChatClientStructuredOutputExtensions.xml
366 lines (366 loc) · 33.2 KB
/
ChatClientStructuredOutputExtensions.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<TypeName="ChatClientStructuredOutputExtensions"FullName="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions">
<TypeSignatureLanguage="C#"Value="public static class ChatClientStructuredOutputExtensions" />
<TypeSignatureLanguage="ILAsm"Value=".class public auto ansi abstract sealed beforefieldinit ChatClientStructuredOutputExtensions extends System.Object" />
<TypeSignatureLanguage="DocId"Value="T:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions" />
<TypeSignatureLanguage="VB.NET"Value="Public Module ChatClientStructuredOutputExtensions" />
<TypeSignatureLanguage="F#"Value="type ChatClientStructuredOutputExtensions = class" />
<TypeSignatureLanguage="C++ CLI"Value="public ref class ChatClientStructuredOutputExtensions abstract sealed" />
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides extension methods on <seecref="T:Microsoft.Extensions.AI.IChatClient" /> that simplify working with structured output.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberMemberName="GetResponseAsync<T>">
<MemberSignatureLanguage="C#"Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T> (this Microsoft.Extensions.AI.IChatClient chatClient, Microsoft.Extensions.AI.ChatMessage chatMessage, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchema = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse`1<!!T>> GetResponseAsync<T>(class Microsoft.Extensions.AI.IChatClient chatClient, class Microsoft.Extensions.AI.ChatMessage chatMessage, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Nullable`1<bool> useJsonSchema, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync``1(Microsoft.Extensions.AI.IChatClient,Microsoft.Extensions.AI.ChatMessage,Microsoft.Extensions.AI.ChatOptions,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As ChatMessage, Optional options As ChatOptions = Nothing, Optional useJsonSchema As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))" />
<MemberSignatureLanguage="F#"Value="static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * Microsoft.Extensions.AI.ChatMessage * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>"Usage="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync (chatClient, chatMessage, options, useJsonSchema, 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.ChatResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameterName="T">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<ParameterName="chatClient"Type="Microsoft.Extensions.AI.IChatClient"RefType="this" />
<ParameterName="chatMessage"Type="Microsoft.Extensions.AI.ChatMessage" />
<ParameterName="options"Type="Microsoft.Extensions.AI.ChatOptions">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<ParameterName="useJsonSchema"Type="System.Nullable<System.Boolean>" />
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparamname="T">The type of structured output to request.</typeparam>
<paramname="chatClient">The <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="chatMessage">The chat message to send.</param>
<paramname="options">The chat options to configure the request.</param>
<paramname="useJsonSchema">
Optionally specifies whether to set a JSON schema on the <seecref="T:Microsoft.Extensions.AI.ChatResponseFormat" />.
This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it.
If not specified, the default value is <seelangword="true" />.
</param>
<paramname="cancellationToken">The <seecref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <seecref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Sends a chat message, requesting a response matching the type <typeparamrefname="T" />.</summary>
<returns>The response messages generated by the client.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="GetResponseAsync<T>">
<MemberSignatureLanguage="C#"Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T> (this Microsoft.Extensions.AI.IChatClient chatClient, System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchema = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse`1<!!T>> GetResponseAsync<T>(class Microsoft.Extensions.AI.IChatClient chatClient, class System.Collections.Generic.IEnumerable`1<class Microsoft.Extensions.AI.ChatMessage> messages, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Nullable`1<bool> useJsonSchema, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync``1(Microsoft.Extensions.AI.IChatClient,System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatOptions,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, messages As IEnumerable(Of ChatMessage), Optional options As ChatOptions = Nothing, Optional useJsonSchema As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))" />
<MemberSignatureLanguage="F#"Value="static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * seq<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>"Usage="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync (chatClient, messages, options, useJsonSchema, 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.ChatResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameterName="T">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<ParameterName="chatClient"Type="Microsoft.Extensions.AI.IChatClient"RefType="this" />
<ParameterName="messages"Type="System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage>" />
<ParameterName="options"Type="Microsoft.Extensions.AI.ChatOptions">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<ParameterName="useJsonSchema"Type="System.Nullable<System.Boolean>" />
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparamname="T">The type of structured output to request.</typeparam>
<paramname="chatClient">The <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="messages">The chat content to send.</param>
<paramname="options">The chat options to configure the request.</param>
<paramname="useJsonSchema">
Optionally specifies whether to set a JSON schema on the <seecref="T:Microsoft.Extensions.AI.ChatResponseFormat" />.
This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it.
If not specified, the default value is <seelangword="true" />.
</param>
<paramname="cancellationToken">The <seecref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <seecref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Sends chat messages, requesting a response matching the type <typeparamrefname="T" />.</summary>
<returns>The response messages generated by the client.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="GetResponseAsync<T>">
<MemberSignatureLanguage="C#"Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T> (this Microsoft.Extensions.AI.IChatClient chatClient, string chatMessage, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchema = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse`1<!!T>> GetResponseAsync<T>(class Microsoft.Extensions.AI.IChatClient chatClient, string chatMessage, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Nullable`1<bool> useJsonSchema, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync``1(Microsoft.Extensions.AI.IChatClient,System.String,Microsoft.Extensions.AI.ChatOptions,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As String, Optional options As ChatOptions = Nothing, Optional useJsonSchema As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))" />
<MemberSignatureLanguage="F#"Value="static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * string * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>"Usage="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync (chatClient, chatMessage, options, useJsonSchema, 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.ChatResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameterName="T">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<ParameterName="chatClient"Type="Microsoft.Extensions.AI.IChatClient"RefType="this" />
<ParameterName="chatMessage"Type="System.String" />
<ParameterName="options"Type="Microsoft.Extensions.AI.ChatOptions">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<ParameterName="useJsonSchema"Type="System.Nullable<System.Boolean>" />
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparamname="T">The type of structured output to request.</typeparam>
<paramname="chatClient">The <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="chatMessage">The text content for the chat message to send.</param>
<paramname="options">The chat options to configure the request.</param>
<paramname="useJsonSchema">
Optionally specifies whether to set a JSON schema on the <seecref="T:Microsoft.Extensions.AI.ChatResponseFormat" />.
This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it.
If not specified, the default value is determined by the implementation.
If a specific value is required, it must be specified by the caller.
</param>
<paramname="cancellationToken">The <seecref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <seecref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Sends a user chat text message, requesting a response matching the type <typeparamrefname="T" />.</summary>
<returns>The response messages generated by the client.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="GetResponseAsync<T>">
<MemberSignatureLanguage="C#"Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T> (this Microsoft.Extensions.AI.IChatClient chatClient, Microsoft.Extensions.AI.ChatMessage chatMessage, System.Text.Json.JsonSerializerOptions serializerOptions, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchema = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse`1<!!T>> GetResponseAsync<T>(class Microsoft.Extensions.AI.IChatClient chatClient, class Microsoft.Extensions.AI.ChatMessage chatMessage, class System.Text.Json.JsonSerializerOptions serializerOptions, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Nullable`1<bool> useJsonSchema, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync``1(Microsoft.Extensions.AI.IChatClient,Microsoft.Extensions.AI.ChatMessage,System.Text.Json.JsonSerializerOptions,Microsoft.Extensions.AI.ChatOptions,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As ChatMessage, serializerOptions As JsonSerializerOptions, Optional options As ChatOptions = Nothing, Optional useJsonSchema As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))" />
<MemberSignatureLanguage="F#"Value="static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * Microsoft.Extensions.AI.ChatMessage * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>"Usage="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync (chatClient, chatMessage, serializerOptions, options, useJsonSchema, 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.ChatResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameterName="T">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<ParameterName="chatClient"Type="Microsoft.Extensions.AI.IChatClient"RefType="this" />
<ParameterName="chatMessage"Type="Microsoft.Extensions.AI.ChatMessage" />
<ParameterName="serializerOptions"Type="System.Text.Json.JsonSerializerOptions" />
<ParameterName="options"Type="Microsoft.Extensions.AI.ChatOptions">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<ParameterName="useJsonSchema"Type="System.Nullable<System.Boolean>" />
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparamname="T">The type of structured output to request.</typeparam>
<paramname="chatClient">The <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="chatMessage">The chat message to send.</param>
<paramname="serializerOptions">The JSON serialization options to use.</param>
<paramname="options">The chat options to configure the request.</param>
<paramname="useJsonSchema">
Optionally specifies whether to set a JSON schema on the <seecref="T:Microsoft.Extensions.AI.ChatResponseFormat" />.
This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it.
If not specified, the default value is <seelangword="true" />.
</param>
<paramname="cancellationToken">The <seecref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <seecref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Sends a chat message, requesting a response matching the type <typeparamrefname="T" />.</summary>
<returns>The response messages generated by the client.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="GetResponseAsync<T>">
<MemberSignatureLanguage="C#"Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T> (this Microsoft.Extensions.AI.IChatClient chatClient, System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, System.Text.Json.JsonSerializerOptions serializerOptions, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchema = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse`1<!!T>> GetResponseAsync<T>(class Microsoft.Extensions.AI.IChatClient chatClient, class System.Collections.Generic.IEnumerable`1<class Microsoft.Extensions.AI.ChatMessage> messages, class System.Text.Json.JsonSerializerOptions serializerOptions, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Nullable`1<bool> useJsonSchema, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync``1(Microsoft.Extensions.AI.IChatClient,System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},System.Text.Json.JsonSerializerOptions,Microsoft.Extensions.AI.ChatOptions,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, messages As IEnumerable(Of ChatMessage), serializerOptions As JsonSerializerOptions, Optional options As ChatOptions = Nothing, Optional useJsonSchema As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))" />
<MemberSignatureLanguage="F#"Value="static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * seq<Microsoft.Extensions.AI.ChatMessage> * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>"Usage="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync (chatClient, messages, serializerOptions, options, useJsonSchema, 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.ChatResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameterName="T">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<ParameterName="chatClient"Type="Microsoft.Extensions.AI.IChatClient"RefType="this" />
<ParameterName="messages"Type="System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage>" />
<ParameterName="serializerOptions"Type="System.Text.Json.JsonSerializerOptions" />
<ParameterName="options"Type="Microsoft.Extensions.AI.ChatOptions">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<ParameterName="useJsonSchema"Type="System.Nullable<System.Boolean>" />
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparamname="T">The type of structured output to request.</typeparam>
<paramname="chatClient">The <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="messages">The chat content to send.</param>
<paramname="serializerOptions">The JSON serialization options to use.</param>
<paramname="options">The chat options to configure the request.</param>
<paramname="useJsonSchema">
Optionally specifies whether to set a JSON schema on the <seecref="T:Microsoft.Extensions.AI.ChatResponseFormat" />.
This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it.
If not specified, the default value is <seelangword="true" />.
</param>
<paramname="cancellationToken">The <seecref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <seecref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Sends chat messages, requesting a response matching the type <typeparamrefname="T" />.</summary>
<returns>The response messages generated by the client.</returns>
<remarks>To be added.</remarks>
<exceptioncref="T:System.ArgumentNullException">
<paramrefname="serializerOptions" /> is <seelangword="null" />.</exception>
</Docs>
</Member>
<MemberMemberName="GetResponseAsync<T>">
<MemberSignatureLanguage="C#"Value="public static System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<T>> GetResponseAsync<T> (this Microsoft.Extensions.AI.IChatClient chatClient, string chatMessage, System.Text.Json.JsonSerializerOptions serializerOptions, Microsoft.Extensions.AI.ChatOptions? options = default, bool? useJsonSchema = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse`1<!!T>> GetResponseAsync<T>(class Microsoft.Extensions.AI.IChatClient chatClient, string chatMessage, class System.Text.Json.JsonSerializerOptions serializerOptions, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Nullable`1<bool> useJsonSchema, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync``1(Microsoft.Extensions.AI.IChatClient,System.String,System.Text.Json.JsonSerializerOptions,Microsoft.Extensions.AI.ChatOptions,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="<Extension()>
Public Function GetResponseAsync(Of T) (chatClient As IChatClient, chatMessage As String, serializerOptions As JsonSerializerOptions, Optional options As ChatOptions = Nothing, Optional useJsonSchema As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse(Of T))" />
<MemberSignatureLanguage="F#"Value="static member GetResponseAsync : Microsoft.Extensions.AI.IChatClient * string * System.Text.Json.JsonSerializerOptions * Microsoft.Extensions.AI.ChatOptions * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse<'T>>"Usage="Microsoft.Extensions.AI.ChatClientStructuredOutputExtensions.GetResponseAsync (chatClient, chatMessage, serializerOptions, options, useJsonSchema, 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.ChatResponse<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameterName="T">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Parameters>
<ParameterName="chatClient"Type="Microsoft.Extensions.AI.IChatClient"RefType="this" />
<ParameterName="chatMessage"Type="System.String" />
<ParameterName="serializerOptions"Type="System.Text.Json.JsonSerializerOptions" />
<ParameterName="options"Type="Microsoft.Extensions.AI.ChatOptions">
<Attributes>
<AttributeFrameworkAlternate="net-10.0-pp;net-8.0-pp;net-9.0-pp">
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<ParameterName="useJsonSchema"Type="System.Nullable<System.Boolean>" />
<ParameterName="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparamname="T">The type of structured output to request.</typeparam>
<paramname="chatClient">The <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="chatMessage">The text content for the chat message to send.</param>
<paramname="serializerOptions">The JSON serialization options to use.</param>
<paramname="options">The chat options to configure the request.</param>
<paramname="useJsonSchema">
Optionally specifies whether to set a JSON schema on the <seecref="T:Microsoft.Extensions.AI.ChatResponseFormat" />.
This improves reliability if the underlying model supports native structured output with a schema, but may cause an error if the model does not support it.
If not specified, the default value is <seelangword="true" />.
</param>
<paramname="cancellationToken">The <seecref="T:System.Threading.CancellationToken" /> to monitor for cancellation requests. The default is <seecref="P:System.Threading.CancellationToken.None" />.</param>
<summary>Sends a user chat text message, requesting a response matching the type <typeparamrefname="T" />.</summary>
<returns>The response messages generated by the client.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
