AIIntegration.AbstractiveSummaryAsync(IAIExtensionsContainer, AbstractiveSummaryRequest, CancellationToken) Method

Generates a brief summary of long text by understanding the context of the original text and rephrasing it in a new, concise form.

Namespace: DevExpress.AIIntegration

Assembly: DevExpress.AIIntegration.v24.2.dll

NuGet Package: DevExpress.AIIntegration

Declaration

C#

public static Task<TextResponse> AbstractiveSummaryAsync(
    this IAIExtensionsContainer container,
    AbstractiveSummaryRequest request,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

<ExtensionAttribute>
Public Shared Function AbstractiveSummaryAsync(
    container As IAIExtensionsContainer,
    request As AbstractiveSummaryRequest,
    cancellationToken As CancellationToken = Nothing
) As Task(Of TextResponse)

Parameters

Name	Type	Description
container	IAIExtensionsContainer	The AI extensions container.
request	AbstractiveSummaryRequest	The request to generate a brief summary of long text.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	The token that cancels the task.

Returns

Type	Description
Task<TextResponse>	The response that contains AI-generated text.

Remarks

The following example registers an Azure Text Analytics client and uses the AI-powered extension to generate a summary for originalText:

using Azure;
using Azure.AI.TextAnalytics;
using DevExpress.AIIntegration;
using DevExpress.AIIntegration.Extensions;

AIExtensionsContainerDefault defaultAIExtensionsContainer;

RegisterTextAnalyticsService(
    Environment.GetEnvironmentVariable("AZURE_TEXT_ANALYTICS_ENDPOINT"),
    Environment.GetEnvironmentVariable("AZURE_TEXT_ANALYTICS_API_KEY")
);

string originalText = "This must be a long text...";
var response = await defaultAIExtensionsContainer.AbstractiveSummaryAsync(
    new AbstractiveSummaryRequest(originalText) { Language = "de", SentenceCount = 3 }
);

Console.WriteLine(response);

void RegisterTextAnalyticsService(string azureTextAnalyticsEndpoint, string azureTextAnalyticsAIKey)
{
    defaultAIExtensionsContainer = new AIExtensionsContainerDefault();
    var textAnalyticsClient = new TextAnalyticsClient(
        new Uri(azureTextAnalyticsEndpoint),
        new AzureKeyCredential(azureTextAnalyticsAIKey)
    );
    defaultAIExtensionsContainer.RegisterTextAnalyticsAzureAIService(textAnalyticsClient);
}