OpenAIResource Class

Definition

Namespace:: Aspire.Hosting.OpenAI

Assembly:: Aspire.Hosting.OpenAI.dll

Package:: Aspire.Hosting.OpenAI v9.5.0-preview.1.25474.7

Source:: OpenAIResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a logical OpenAI account/configuration that can host one or more OpenAIModelResource children.

public sealed class OpenAIResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString

type OpenAIResource = class
    inherit Resource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

Public NotInheritable Class OpenAIResource
Inherits Resource
Implements IResourceWithConnectionString

Inheritance: Object

Resource
OpenAIResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IValueProvider IValueWithReferences

Constructors

OpenAIResource(String, ParameterResource)

Creates a new OpenAIResource.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConnectionStringExpression	Gets the base connection string for the OpenAI account.
Endpoint	Gets or sets the service endpoint base URI for OpenAI-compatible services. Defaults to https://api.openai.com/v1.
Key	Gets or sets the API key for accessing OpenAI.
Name	Gets the name of the resource. (Inherited from Resource)

Extension Methods

GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)	Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
IsExcludedFromPublish(IResource)	Gets a value indicating whether the resource is excluded from being published.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
RequiresImageBuildAndPush(IResource)	Determines whether the specified resource requires image building and pushing.
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)	Attempts to retrieve the URLs for the given resource.
AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, String, Nullable<Boolean>)	Creates a new ProvisioningParameter in `infrastructure`, or reuses an existing bicep parameter if one with
IsContainer(IResource)	Determines whether the specified resource is a container resource.
AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)	Creates a placeholder for an environment variable in the Docker Compose file.
IsEmulator(IResource)	Determines whether the specified resource is an emulator resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Feedback

Was this page helpful?