Find embedding providers (C#)

Gets information about embedding providers for automatic embedding generation, including supported providers, models, dimensions, and other configuration parameters.

Different databases might have different models available.

You need an application token with permission to interact with the target database, such as the Database Administrator role.

For more information, see Get endpoint and token.

Result

Returns a FindEmbeddingProvidersResult, which is a dictionary with the embedding provider name as the keys, and EmbeddingProvider objects as the values.

Parameters

Use the FindEmbeddingProvidersAsync method, which belongs to the IDatabaseAdmin class. You can also use FindEmbeddingProviders, which is the synchronous version of the method.

Method signature
Task<FindEmbeddingProvidersResult> FindEmbeddingProvidersAsync(
  FindEmbeddingProvidersOptions options = null
);
Name Type Summary

options

FindEmbeddingProvidersOptions

Optional. Options for this operation. For more information and examples for general options such as timeout, see Customize API interaction. For options specific to this method, see Method-specific properties of the FindEmbeddingProvidersOptions class.

Method-specific properties of the FindEmbeddingProvidersOptions class
Name Type Summary

FilterModelStatus

ModelLifecycleStatus

Optional. Filters the available models by status.

Default: ModelLifecycleStatus.Supported

Examples

The following examples demonstrate how to find embedding providers.

using DataStax.AstraDB.DataApi;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient();
    var database = client.GetDatabase(
      "API_ENDPOINT",
      "APPLICATION_TOKEN"
    );

    var databaseAdmin = database.GetAdmin();

    var result = await databaseAdmin.FindEmbeddingProvidersAsync();

    var providers = result.EmbeddingProviders;
  }
}

Client reference

For more information, see the client reference.

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM