FailoverChatClientAttempt Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.dll

Package:

Microsoft.Extensions.AI v10.9.0

Source:

FailoverChatClientAttempt.cs

Represents one client invocation attempt performed by a FailoverChatClient.

public ref class FailoverChatClientAttempt sealed

[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public sealed class FailoverChatClientAttempt

[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type FailoverChatClientAttempt = class

Public NotInheritable Class FailoverChatClientAttempt

Inheritance

Object

FailoverChatClientAttempt

Attributes

ExperimentalAttribute

Remarks

A completed response has ResponseCompleted set to true and Exception set to null.

A failed invocation has ResponseCompleted set to false and Exception set to the observed exception. If a streaming caller stops enumerating before the response ends and disposal completes successfully, both ResponseCompleted and Exception are unset.

OutputCommitted is independent of the outcome and indicates whether any streaming update was exposed to the caller.

Properties

Name	Description
Client	Gets the client that was invoked.
Duration	Gets the time spent actively invoking the client.
Exception	Gets the exception observed while invoking or disposing the client, if any.
OutputCommitted	Gets a value indicating whether any streaming update was exposed to the caller.
ResponseCompleted	Gets a value indicating whether the response completed successfully.
TimeToFirstUpdate	Gets the time until the first streaming update, if this was a non-empty streaming invocation.