Back to Devexpress

AIIntegration.ProofreadAsync(IAIExtensionsContainer, ProofreadRequest, CancellationToken) Method

corelibraries-devexpress-dot-aiintegration-dot-aiintegration-dot-proofreadasync-x28-iaiextensionscontainer-proofreadrequest-cancellationtoken-x29.md

latest4.0 KB
Original Source

AIIntegration.ProofreadAsync(IAIExtensionsContainer, ProofreadRequest, CancellationToken) Method

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

Namespace : DevExpress.AIIntegration

Assembly : DevExpress.AIIntegration.v25.2.dll

NuGet Package : DevExpress.AIIntegration

Declaration

csharp
public static Task<TextResponse> ProofreadAsync(
    this IAIExtensionsContainer container,
    ProofreadRequest request,
    CancellationToken cancellationToken = default(CancellationToken)
)
vb
<ExtensionAttribute>
Public Shared Function ProofreadAsync(
    container As IAIExtensionsContainer,
    request As ProofreadRequest,
    cancellationToken As CancellationToken = Nothing
) As Task(Of TextResponse)

Parameters

NameTypeDescription
containerIAIExtensionsContainer

The AI extensions container.

| | request | ProofreadRequest |

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

|

Optional Parameters

NameTypeDefaultDescription
cancellationTokenCancellationTokennull

The token that cancels the task.

|

Returns

TypeDescription
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:

csharp
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 Azure.AI.OpenAI.AzureOpenAIClient(new Uri(azureOpenAIEndpoint),
        new System.ClientModel.ApiKeyCredential(azureOpenAIKey)).GetChatClient("gpt-4o-mini").AsIChatClient();

    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

AIIntegration Class

AIIntegration Members

DevExpress.AIIntegration Namespace