ShortenRequest Class

SECURITY-RELATED CONSIDERATIONS

This API includes automatic prompt-injection protection for text and document-based AI-powered extensions. The system appends security instructions to each AI request to ensure that external or user-provided content is treated as untrusted data.

Prompt Injection Protection in AI Extensions

A request to remove unnecessary details and make text more concise.

Namespace: DevExpress.AIIntegration.Extensions

Assembly: DevExpress.AIIntegration.v26.1.dll

Declaration

C#

public class ShortenRequest :
    TextRequest

VB.NET

Public Class ShortenRequest
    Inherits TextRequest

Remarks

The following example registers an Azure OpenAI client and uses the AI-powered extension to shorten 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 = "Effective communication is essential in any professional setting, as it ensures that all parties involved are on the same page and working toward the same goals. Without clear communication, misunderstandings can arise, leading to errors, delays, and even conflict among team members.";
var response = await defaultAIExtensionsContainer.ShortenAsync(
    new ShortenRequest(originalText)
);

Console.WriteLine(response);

/* Output:
 * Effective communication is crucial in professional settings for aligning all parties toward common goals.
 * Lack of clear communication can result in misunderstandings, errors, delays, and conflicts among team members.
 */

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});
}

Inheritance

Object

DevExpress.AIIntegration.Extensions.BaseRequest

TextRequest

ShortenRequest