Skip to main content
All docs
V24.2

AIIntegration.ProofreadAsync(IAIExtensionsContainer, ProofreadRequest, CancellationToken) Method

Reviews the text for spelling, grammar, punctuation, and style errors.

Namespace: DevExpress.AIIntegration

Assembly: DevExpress.AIIntegration.v24.2.dll

NuGet Package: DevExpress.AIIntegration

#Declaration

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

#Parameters

Name Type Description
container IAIExtensionsContainer

The AI extensions container.

request ProofreadRequest

The request to review the text for spelling, grammar, punctuation, and style errors.

#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 OpenAI client and uses the AI-powered extension to proofread originalText in a .NET console application:

C#
using Azure;
using Azure.AI.OpenAI;
using Microsoft.Extensions.AI;
using DevExpress.AIIntegration;
using DevExpress.AIIntegration.Extensions;

SetEnvironmentVariables();

// Register an Azure OpenAI client
AIExtensionsContainerDefault defaultAIExtensionsContainer = RegisterAzureOpenAIClient(
    Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"),
    Environment.GetEnvironmentVariable("AZURE_OPENAI_APIKEY")
);

string originalText = "DevExpress AI APIs allaw to yuo register and used multiple AI services within WinForms WPF or Blazor aplication.";
var response = await defaultAIExtensionsContainer.ProofreadAsync(
    new ProofreadRequest(originalText)
);

Console.WriteLine(response);

/* Output:
 * DevExpress AI APIs allow you to register and use multiple AI services within WinForms, WPF, or Blazor applications.
 */

AIExtensionsContainerDefault RegisterAzureOpenAIClient(string azureOpenAIEndpoint, string azureOpenAIKey) {
    IChatClient client = new AzureOpenAIClient(
        new Uri(azureOpenAIEndpoint),
        new AzureKeyCredential(azureOpenAIKey))
            .AsChatClient("gpt-4o-mini");
    return AIExtensionsContainerConsole.CreateDefaultAIExtensionContainer(client);
}

void SetEnvironmentVariables() {
    Environment.SetEnvironmentVariable("AZURE_OPENAI_ENDPOINT", {SPECIFY_YOUR_AZURE_ENDPOINT});
    Environment.SetEnvironmentVariable("AZURE_OPENAI_APIKEY", {SPECIFY_YOU_AZURE_KEY});
}
See Also