Edit

AI integrations

The experimental Microsoft.Testing.Platform.AI package defines provider-neutral AI abstractions for test frameworks and MTP extensions. The package integrates with Microsoft.Extensions.AI, so an extension can request an IChatClient without depending on a specific model provider.

Important

The AI APIs use the TPEXP diagnostic ID and can change in a future release. The packages supply infrastructure to extensions; they don't add AI behavior to a test suite by themselves.

Choose the packages

Add the abstractions package when you author an extension that consumes a chat client. Add a provider package to the test application that hosts the extension:

dotnet add package Microsoft.Testing.Platform.AI
dotnet add package Microsoft.Testing.Extensions.AzureFoundry

Microsoft.Testing.Extensions.AzureFoundry is the Microsoft-provided reference provider. It creates an Azure OpenAI chat client through Azure AI Foundry.

Configure Azure AI Foundry

Set the following environment variables:

Variable Required Description
AZURE_OPENAI_ENDPOINT Yes The Azure OpenAI resource endpoint, such as https://my-resource.openai.azure.com.
AZURE_OPENAI_DEPLOYMENT_NAME Yes The model deployment name.
AZURE_OPENAI_API_KEY Conditional The resource API key. Set this value unless you register a TokenCredential in code.

To keep credentials out of source control, supply these values through your local environment or a protected CI secret store.

Register the provider

Disable the generated MTP entry point and register the provider in your custom Main method. For API-key authentication, call:

#pragma warning disable TPEXP
builder.AddAzureOpenAIChatClientProvider();
#pragma warning restore TPEXP

For Microsoft Entra ID or managed identity, reference the Azure.Identity package and pass a credential:

using Azure.Identity;

#pragma warning disable TPEXP
builder.AddAzureOpenAIChatClientProvider(new DefaultAzureCredential());
#pragma warning restore TPEXP

When AZURE_OPENAI_API_KEY is set, the provider uses the API key before the supplied credential. Credential resolution and authentication occur when the first chat request runs, so configuration errors might not appear during provider registration.

Consume a chat client

Implement IChatClientProvider to integrate another AI provider. An MTP extension can retrieve the registered chat client from its IServiceProvider:

IChatClient? client =
    await serviceProvider.GetChatClientAsync(cancellationToken);

The call returns null when no available provider is registered. Before an extension sends test data to a model, document what data it sends and apply the privacy, security, and retention requirements for that data.

See also

  • Last updated on