OpenAIResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.OpenAI / OpenAIResource

OpenAIResource

Docs Reference TypeScript APIs Aspire.Hosting.OpenAI OpenAIResource

Handle TypeScript

📦 Aspire.Hosting.OpenAI v13.2.0-preview.1.26159.1

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

Implements

• IManifestExpressionProvider
• IResource
• IResourceWithConnectionString
• IValueProvider
• IValueWithReferences

Methods

method addModel builder

Adds an OpenAI model resource.

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

Parameters

name string

model string

Returns

OpenAIModelResource

method withApiKey builder

Configures the API key for the OpenAI resource.

withApiKey(apiKey: ParameterResource): OpenAIResource

Parameters

apiKey ParameterResource

Returns

OpenAIResource

method withEndpoint builder

Configures the endpoint URI for the OpenAI resource.

withEndpoint(endpoint: string): OpenAIResource

Parameters

endpoint string

Returns

OpenAIResource