Back to Devexpress

AIDocProcessingExtensions.CreateAIDocProcessingService(AIExtensionsContainer) Method

officefileapi-devexpress-dot-aiintegration-dot-docs-dot-aidocprocessingextensions-dot-createaidocprocessingservice-x28-devexpress-dot-aiintegration-dot-aiextensionscontainer-x29.md

latest5.0 KB
Original Source

AIDocProcessingExtensions.CreateAIDocProcessingService(AIExtensionsContainer) Method

Registers a container in a console application.

Namespace : DevExpress.AIIntegration.Docs

Assembly : DevExpress.AIIntegration.Docs.v25.2.dll

NuGet Package : DevExpress.AIIntegration.Docs

Declaration

csharp
[DXBrowsable(true)]
public static IAIDocProcessingService CreateAIDocProcessingService(
    this AIExtensionsContainer container
)
vb
<DXBrowsable(True)>
<ExtensionAttribute>
Public Shared Function CreateAIDocProcessingService(
    container As AIExtensionsContainer
) As IAIDocProcessingService

Parameters

NameTypeDescription
containerAIExtensionsContainer

The container that holds the registered AI client.

|

Returns

TypeDescription
IAIDocProcessingService

A service for AI-powered extensions.

|

Example

How to: Register Ai-powered Extensions in a Console Application

The following code snippet registers an Azure Open AI client and creates and extension service:

csharp
using DevExpress.AIIntegration;
using Microsoft.Extensions.AI;
using System.Globalization;

// Configure Azure OpenAI endpoint and API key via environment variables.
Environment.SetEnvironmentVariable(
    "AZURE_OPENAI_ENDPOINT",
    "<YOUR_AZURE_OPENAI_ENDPOINT>");
Environment.SetEnvironmentVariable(
    "AZURE_OPENAI_APIKEY",
    "<YOUR_AZURE_OPENAI_KEY>");
var modelName = "gpt-4o-mini";

// Register an Azure OpenAI client and obtain the
// default AI extensions container.
AIExtensionsContainerDefault defaultAIExtensionsContainer =
    RegisterAzureOpenAIClient(
        Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"),
        Environment.GetEnvironmentVariable("AZURE_OPENAI_APIKEY"));

// Create a document processing service instance
// from the AI extensions container.
var docProcessingService =
    defaultAIExtensionsContainer.CreateAIDocProcessingService();

// Helper method that creates and configures an Azure OpenAI chat client
// and wraps it in a default AI extensions container.
AIExtensionsContainerDefault RegisterAzureOpenAIClient(
    string azureOpenAIEndpoint,
    string azureOpenAIKey)
{
    IChatClient client =
        new Azure.AI.OpenAI.AzureOpenAIClient(
            new Uri(azureOpenAIEndpoint),
            new System.ClientModel.ApiKeyCredential(azureOpenAIKey))
        .GetChatClient(modelName)
        .AsIChatClient();

    return AIExtensionsContainerConsole.CreateDefaultAIExtensionContainer(client);
}
vb
Imports DevExpress.AIIntegration
Imports Microsoft.Extensions.AI
Imports System.Globalization
Imports System

' Configure Azure OpenAI endpoint and API key via environment variables.
Environment.SetEnvironmentVariable(
    "AZURE_OPENAI_ENDPOINT",
    "<YOUR_AZURE_OPENAI_ENDPOINT>")
Environment.SetEnvironmentVariable(
    "AZURE_OPENAI_APIKEY",
    "<YOUR_AZURE_OPENAI_KEY>")
Dim modelName = "gpt-4o-mini"

' Register an Azure OpenAI client and obtain the
' default AI extensions container.
Dim defaultAIExtensionsContainer As AIExtensionsContainerDefault = _
    RegisterAzureOpenAIClient(
        Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT"), _
        Environment.GetEnvironmentVariable("AZURE_OPENAI_APIKEY"))

' Create a document processing service instance
' from the AI extensions container.
Dim docProcessingService = _
    defaultAIExtensionsContainer.CreateAIDocProcessingService()

' Helper method that creates and configures an Azure OpenAI chat client
' and wraps it in a default AI extensions container.
Private Function RegisterAzureOpenAIClient(
    azureOpenAIEndpoint As String,
    azureOpenAIKey As String) As AIExtensionsContainerDefault
    Dim client As IChatClient = New Azure.AI.OpenAI.AzureOpenAIClient( _
        New Uri(azureOpenAIEndpoint), _
        New System.ClientModel.ApiKeyCredential(azureOpenAIKey)) _
        .GetChatClient("gpt-4o-mini") _
        .AsIChatClient()

    Return AIExtensionsContainerConsole.CreateDefaultAIExtensionContainer(client)
End Function

See Also

AIDocProcessingExtensions Class

AIDocProcessingExtensions Members

DevExpress.AIIntegration.Docs Namespace