OpenAIResource

Handle

📦 Aspire.Hosting.OpenAI v13.4.0

interface OpenAIResource
  extends IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IValueProvider,
    IValueWithReferences {
  addModel(
      name: string,
      model: string): OpenAIModelResource;
  withApiKey(apiKey: ParameterResource): OpenAIResource;
  withEndpoint(endpoint: string): OpenAIResource;
}

Methods

method addModel builder

Adds an OpenAI Model child to the provided OpenAI resource.

addModel(
    name: string,
    model: string): OpenAIModelResource

Parameters

name string

model string

Returns

OpenAIModelResource

method withApiKey builder

Configures the API key for the OpenAI parent resource from a parameter.

withApiKey(apiKey: ParameterResource): OpenAIResource

Parameters

apiKey ParameterResource

Returns

OpenAIResource

method withEndpoint builder

Sets a custom OpenAI-compatible service endpoint URI on the parent resource.

withEndpoint(endpoint: string): OpenAIResource

Parameters

endpoint string

Returns

OpenAIResource