Share via


GitHubModelsExtensions.WithHealthCheck Method

Definition

Adds a health check to the GitHub Model resource.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.GitHub.Models.GitHubModelResource> WithHealthCheck(this Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.GitHub.Models.GitHubModelResource> builder);
static member WithHealthCheck : Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.GitHub.Models.GitHubModelResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.GitHub.Models.GitHubModelResource>
<Extension()>
Public Function WithHealthCheck (builder As IResourceBuilder(Of GitHubModelResource)) As IResourceBuilder(Of GitHubModelResource)

Parameters

builder
IResourceBuilder<GitHubModelResource>

The resource builder.

Returns

The resource builder.

Remarks

This method adds a health check that verifies the GitHub Models endpoint is accessible, the API key is valid, and the specified model is available. The health check will:

Because health checks are included in the rate limit of the GitHub Models API, it is recommended to use this health check sparingly, such as when you are having issues understanding the reason the model is not working as expected. Furthermore, the health check will run a single time per application instance.

Applies to