Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

OpenAIResource

Handle
📦 Aspire.Hosting.OpenAI v17.0.0
type OpenAIResource interface {
ExpressionValue
Resource
ResourceWithConnectionString
}

Methods

methodAddModelbuilder
Adds an OpenAI Model child to the provided OpenAI resource.
AddModel(
name string,
model string,
) OpenAIModelResource
namestringThe name of the model resource. This name is used as the connection string name.
modelstringThe model identifier, e.g., "gpt-4o-mini".
OpenAIModelResource

The model resource builder.

Returns a handle; failures surface later via Err().

methodWithApiKeybuilder
Configures the API key for the OpenAI parent resource from a parameter.
WithApiKey(apiKey ParameterResource) OpenAIResource
apiKeyParameterResource
OpenAIResource

Returns a handle; failures surface later via Err().

methodWithEndpointbuilder
Sets a custom OpenAI-compatible service endpoint URI on the parent resource.
WithEndpoint(endpoint string) OpenAIResource
endpointstringThe endpoint URI, e.g., https://mygateway.example.com/v1.
OpenAIResource

Returns a handle; failures surface later via Err().