ChatResponseExtensions.ToChatResponse Method

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v9.4.0-preview.1.25207.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Combines ChatResponseUpdate instances into a single ChatResponse.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::AI::ChatResponse ^ ToChatResponse(System::Collections::Generic::IEnumerable<Microsoft::Extensions::AI::ChatResponseUpdate ^> ^ updates);

public static Microsoft.Extensions.AI.ChatResponse ToChatResponse(this System.Collections.Generic.IEnumerable<Microsoft.Extensions.AI.ChatResponseUpdate> updates);

static member ToChatResponse : seq<Microsoft.Extensions.AI.ChatResponseUpdate> -> Microsoft.Extensions.AI.ChatResponse

<Extension()>
Public Function ToChatResponse (updates As IEnumerable(Of ChatResponseUpdate)) As ChatResponse

Parameters

updates: IEnumerable<ChatResponseUpdate>

The updates to be combined.

Returns

ChatResponse

The combined ChatResponse.

Exceptions

ArgumentNullException

updates is null.

Remarks

As part of combining updates into a single ChatResponse, the method will attempt to reconstruct ChatMessage instances. This includes using MessageId to determine message boundaries, as well as coalescing contiguous AIContent items where applicable, e.g. multiple TextContent instances in a row may be combined into a single TextContent.

Applies to

Share via