DevUIExtensions.MapDevUI(IEndpointRouteBuilder) Method

Definition

Maps an endpoint that serves the DevUI from the '/devui' path.

public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapDevUI(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints);
static member MapDevUI : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder -> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder
<Extension()>
Public Function MapDevUI (endpoints As IEndpointRouteBuilder) As IEndpointConventionBuilder

Parameters

endpoints
IEndpointRouteBuilder

The IEndpointRouteBuilder to add the endpoint to.

Returns

A IEndpointConventionBuilder that can be used to add authorization or other endpoint configuration.

Exceptions

Thrown when endpoints is null.

Remarks

DevUI requires the OpenAI Responses and Conversations services to be registered with AddOpenAIResponses(IServiceCollection) and AddOpenAIConversations(IServiceCollection), and the corresponding endpoints to be mapped using MapOpenAIResponses(IEndpointRouteBuilder) and MapOpenAIConversations(IEndpointRouteBuilder).

DevUI is restricted to loopback callers unless AllowRemoteAccess is set. See DevUIOptions for the available authentication and authorization hooks.

Applies to

See also