AspireEmbeddingsClientBuilder Constructors

Docs / Reference / Search C# APIs / Aspire.Azure.AI.Inference / AspireEmbeddingsClientBuilder / Constructors

Constructors

Docs Reference Search C# APIs Aspire.Azure.AI.Inference AspireEmbeddingsClientBuilder Constructors

Class Constructors 1 member

Provides a builder for configuring and integrating an Aspire Embeddings client into a host application.

Constructor(IHostApplicationBuilder, string?, string?, bool, bool)

Provides a builder for configuring and integrating an Aspire Embeddings client into a host application.

public class AspireEmbeddingsClientBuilder
{
    public AspireEmbeddingsClientBuilder(
        IHostApplicationBuilder hostBuilder,
        string? serviceKey,
        string? deploymentName,
        bool disableTracing,
        bool enableSensitiveTelemetryData)
    {
        // ...
    }
}

AspireEmbeddingsClientBuilder.cs#L20-L50

Parameters

hostBuilder IHostApplicationBuilder The Hosting.IHostApplicationBuilder with which services are being registered.

serviceKey string? The service key used to register the Inference.EmbeddingsClient service, if any.

deploymentName string? The name of the deployment in Azure AI Foundry.

disableTracing bool A flag to indicate whether tracing should be disabled.

enableSensitiveTelemetryData bool A flag indicating whether potentially sensitive information should be included in telemetry.

Remarks

This class is used to configure the necessary parameters for creating an Aspire Embeddings client, such as the host application builder, service key, and optional model ID. It is intended for internal use within the application setup process.