Back to Devexpress

AIIntegration.ChangeToneAsync(IAIExtensionsContainer, ChangeToneRequest, CancellationToken) Method

corelibraries-devexpress-dot-aiintegration-dot-aiintegration-dot-changetoneasync-x28-iaiextensionscontainer-changetonerequest-cancellationtoken-x29.md

latest3.9 KB
Original Source

AIIntegration.ChangeToneAsync(IAIExtensionsContainer, ChangeToneRequest, CancellationToken) Method

Adjusts the tone of the text.

Namespace : DevExpress.AIIntegration

Assembly : DevExpress.AIIntegration.v25.2.dll

NuGet Package : DevExpress.AIIntegration

Declaration

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

Parameters

NameTypeDescription
containerIAIExtensionsContainer

The AI extensions container.

| | request | ChangeToneRequest |

The request to adjust the tone of the text.

|

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 adjust the tone of originalText:

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 = "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 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