- Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathLoggingChatClient.xml
164 lines (164 loc) · 12.6 KB
/
LoggingChatClient.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
<TypeName="LoggingChatClient"FullName="Microsoft.Extensions.AI.LoggingChatClient">
<TypeSignatureLanguage="C#"Value="public class LoggingChatClient : Microsoft.Extensions.AI.DelegatingChatClient" />
<TypeSignatureLanguage="ILAsm"Value=".class public auto ansi beforefieldinit LoggingChatClient extends Microsoft.Extensions.AI.DelegatingChatClient" />
<TypeSignatureLanguage="DocId"Value="T:Microsoft.Extensions.AI.LoggingChatClient" />
<TypeSignatureLanguage="VB.NET"Value="Public Class LoggingChatClient
Inherits DelegatingChatClient" />
<TypeSignatureLanguage="F#"Value="type LoggingChatClient = class
 inherit DelegatingChatClient" />
<TypeSignatureLanguage="C++ CLI"Value="public ref class LoggingChatClient : Microsoft::Extensions::AI::DelegatingChatClient" />
<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>Microsoft.Extensions.AI.DelegatingChatClient</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>A delegating chat client that logs chat operations to an <seecref="T:Microsoft.Extensions.Logging.ILogger" />.</summary>
<remarks>To be added.</remarks>
<para>
The provided implementation of <seecref="T:Microsoft.Extensions.AI.IChatClient" /> is thread-safe for concurrent use so long as the
<seecref="T:Microsoft.Extensions.Logging.ILogger" /> employed is also thread-safe for concurrent use.
</para>
</Docs>
<Members>
<MemberMemberName=".ctor">
<MemberSignatureLanguage="C#"Value="public LoggingChatClient (Microsoft.Extensions.AI.IChatClient innerClient, Microsoft.Extensions.Logging.ILogger logger);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.AI.IChatClient innerClient, class Microsoft.Extensions.Logging.ILogger logger) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.LoggingChatClient.#ctor(Microsoft.Extensions.AI.IChatClient,Microsoft.Extensions.Logging.ILogger)" />
<MemberSignatureLanguage="VB.NET"Value="Public Sub New (innerClient As IChatClient, logger As ILogger)" />
<MemberSignatureLanguage="F#"Value="new Microsoft.Extensions.AI.LoggingChatClient : Microsoft.Extensions.AI.IChatClient * Microsoft.Extensions.Logging.ILogger -> Microsoft.Extensions.AI.LoggingChatClient"Usage="new Microsoft.Extensions.AI.LoggingChatClient (innerClient, logger)" />
<MemberSignatureLanguage="C++ CLI"Value="public:
 LoggingChatClient(Microsoft::Extensions::AI::IChatClient ^ innerClient, Microsoft::Extensions::Logging::ILogger ^ logger);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<ParameterName="innerClient"Type="Microsoft.Extensions.AI.IChatClient" />
<ParameterName="logger"Type="Microsoft.Extensions.Logging.ILogger" />
</Parameters>
<Docs>
<paramname="innerClient">The underlying <seecref="T:Microsoft.Extensions.AI.IChatClient" />.</param>
<paramname="logger">An <seecref="T:Microsoft.Extensions.Logging.ILogger" /> instance that will be used for all logging.</param>
<summary>Initializes a new instance of the <seecref="T:Microsoft.Extensions.AI.LoggingChatClient" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberMemberName="GetResponseAsync">
<MemberSignatureLanguage="C#"Value="public override System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse> GetResponseAsync (System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatOptions? options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Extensions.AI.ChatResponse> GetResponseAsync(class System.Collections.Generic.IEnumerable`1<class Microsoft.Extensions.AI.ChatMessage> messages, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.LoggingChatClient.GetResponseAsync(System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatOptions,System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="Public Overrides Function GetResponseAsync (messages As IEnumerable(Of ChatMessage), Optional options As ChatOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChatResponse)" />
<MemberSignatureLanguage="F#"Value="override this.GetResponseAsync : seq<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.ChatResponse>"Usage="loggingChatClient.GetResponseAsync (messages, 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.ChatResponse></ReturnType>
</ReturnValue>
<Parameters>
<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="cancellationToken"Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<paramname="messages">To be added.</param>
<paramname="options">To be added.</param>
<paramname="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<MemberMemberName="GetStreamingResponseAsync">
<MemberSignatureLanguage="C#"Value="public override System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate> GetStreamingResponseAsync (System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatMessage> messages, Microsoft.Extensions.AI.ChatOptions? options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignatureLanguage="ILAsm"Value=".method public hidebysig virtual instance class System.Collections.Generic.IAsyncEnumerable`1<class Microsoft.Extensions.AI.ChatResponseUpdate> GetStreamingResponseAsync(class System.Collections.Generic.IEnumerable`1<class Microsoft.Extensions.AI.ChatMessage> messages, class Microsoft.Extensions.AI.ChatOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.AI.LoggingChatClient.GetStreamingResponseAsync(System.Collections.Generic.IEnumerable{Microsoft.Extensions.AI.ChatMessage},Microsoft.Extensions.AI.ChatOptions,System.Threading.CancellationToken)" />
<MemberSignatureLanguage="VB.NET"Value="Public Overrides Function GetStreamingResponseAsync (messages As IEnumerable(Of ChatMessage), Optional options As ChatOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of ChatResponseUpdate)" />
<MemberSignatureLanguage="F#"Value="override this.GetStreamingResponseAsync : seq<Microsoft.Extensions.AI.ChatMessage> * Microsoft.Extensions.AI.ChatOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate>"Usage="loggingChatClient.GetStreamingResponseAsync (messages, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Microsoft.Extensions.AI.LoggingChatClient+<GetStreamingResponseAsync>d__7))]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Microsoft.Extensions.AI.LoggingChatClient+<GetStreamingResponseAsync>d__7))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IAsyncEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate></ReturnType>
</ReturnValue>
<Parameters>
<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="cancellationToken"Type="System.Threading.CancellationToken">
<Attributes>
<Attribute>
<AttributeNameLanguage="C#">[System.Runtime.CompilerServices.EnumeratorCancellation]</AttributeName>
<AttributeNameLanguage="F#">[<System.Runtime.CompilerServices.EnumeratorCancellation>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<paramname="messages">To be added.</param>
<paramname="options">To be added.</param>
<paramname="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<MemberMemberName="JsonSerializerOptions">
<MemberSignatureLanguage="C#"Value="public System.Text.Json.JsonSerializerOptions JsonSerializerOptions { get; set; }" />
<MemberSignatureLanguage="ILAsm"Value=".property instance class System.Text.Json.JsonSerializerOptions JsonSerializerOptions" />
<MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.AI.LoggingChatClient.JsonSerializerOptions" />
<MemberSignatureLanguage="VB.NET"Value="Public Property JsonSerializerOptions As JsonSerializerOptions" />
<MemberSignatureLanguage="F#"Value="member this.JsonSerializerOptions : System.Text.Json.JsonSerializerOptions with get, set"Usage="Microsoft.Extensions.AI.LoggingChatClient.JsonSerializerOptions" />
<MemberSignatureLanguage="C++ CLI"Value="public:
 property System::Text::Json::JsonSerializerOptions ^ JsonSerializerOptions { System::Text::Json::JsonSerializerOptions ^ get(); void set(System::Text::Json::JsonSerializerOptions ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.AI</AssemblyName>
<AssemblyVersion>9.4.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Text.Json.JsonSerializerOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets JSON serialization options to use when serializing logging data.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
