Class EmbeddingProvider.Parameter

Namespace

DataStax.AstraDB.DataApi.Core.Results

Assembly

DataStax.AstraDB.DataApi.dll

Describes a configuration parameter for an EmbeddingProvider or one of its models.

public class EmbeddingProvider.Parameter

Inheritance

object

EmbeddingProvider.Parameter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DefaultValue

The default value for this parameter, if any.

public string DefaultValue { get; set; }

Property Value

string

DisplayName

The human-readable display name of the parameter.

public string DisplayName { get; set; }

Property Value

string

Help

Help text describing the purpose of the parameter.

public string Help { get; set; }

Property Value

string

Hint

A hint shown in UI contexts to assist with filling in this parameter.

public string Hint { get; set; }

Property Value

string

Name

The parameter name.

public string Name { get; set; }

Property Value

string

Required

Indicates whether this parameter is required.

public bool Required { get; set; }

Property Value

bool

Type

The data type of the parameter.

public string Type { get; set; }

Property Value

string

Validation

Validation constraints for this parameter.

public Dictionary<string, List<int>> Validation { get; set; }

Property Value

Dictionary<string, List<int>>