AIIntegration.ChangeToneAsync(IAIExtensionsContainer, ChangeToneRequest, CancellationToken) Method

Adjusts the tone of the text.

Namespace: DevExpress.AIIntegration

Assembly: DevExpress.AIIntegration.v24.2.dll

Declaration

C#

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

VB.NET

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

Parameters

Name	Type	Description
container	IAIExtensionsContainer	The AI extensions container.
request	ChangeToneRequest	The request to adjust the tone of the 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 OpenAI client and uses the AI-powered extension to adjust the tone of originalText:

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 = "The Adjust Tone AI-powered extension adjusts the tone of the text to meet audience or context requirements.";
var response = await defaultAIExtensionsContainer.ChangeToneAsync(
    new ChangeToneRequest(originalText, ToneStyle.Casual)
);

Console.WriteLine(response);

/* Output:
 * Tone Tweaker is an AI tool that changes the vibe of your text to fit your crowd or situation.
 */

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

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