Class EmbeddingProvider

Namespace

DataStax.AstraDB.DataApi.Core.Results

Assembly

DataStax.AstraDB.DataApi.dll

Describes an embedding provider (such as OpenAI) that can generate vector embeddings for use with the Data API.

public class EmbeddingProvider

Inheritance

object

EmbeddingProvider

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Fields

AuthenticationMethodHeader

Constant representing header-based authentication.

public const string AuthenticationMethodHeader = "HEADER"

Field Value

string

AuthenticationMethodNone

Constant representing no authentication required.

public const string AuthenticationMethodNone = "NONE"

Field Value

string

AuthenticationMethodSharedSecret

Constant representing shared-secret authentication.

public const string AuthenticationMethodSharedSecret = "SHARED_SECRET"

Field Value

string

Properties

DisplayName

The human-readable display name of the embedding provider.

public string DisplayName { get; set; }

Property Value

string

Models

The embedding models available from this provider.

public List<EmbeddingProvider.Model> Models { get; set; }

Property Value

List<EmbeddingProvider.Model>

Parameters

Configuration parameters accepted by this embedding provider.

public List<EmbeddingProvider.Parameter> Parameters { get; set; }

Property Value

List<EmbeddingProvider.Parameter>

SupportedAuthentication

The authentication methods supported by this provider, keyed by method name.

public Dictionary<string, EmbeddingProvider.AuthenticationMethod> SupportedAuthentication { get; set; }

Property Value

Dictionary<string, EmbeddingProvider.AuthenticationMethod>

Url

The base URL for the embedding provider's API endpoint.

public string Url { get; set; }

Property Value

string