Class VectorDatabase

Namespace

FoundationaLLM.Common.Models.ResourceProviders.Vector

Assembly

FoundationaLLM.Common.dll

Represents a vector database resource.

public class VectorDatabase : ResourceBase

Inheritance

object

ResourceName

ResourceBase

VectorDatabase

Inherited Members

ResourceBase.ObjectId

ResourceBase.ResourcePath

ResourceBase.DisplayName

ResourceBase.Description

ResourceBase.CostCenter

ResourceBase.Properties

ResourceBase.CreatedOn

ResourceBase.UpdatedOn

ResourceBase.CreatedBy

ResourceBase.UpdatedBy

ResourceBase.Deleted

ResourceBase.ExpirationDate

ResourceBase.InheritableAuthorizableActions

ResourceName.Type

ResourceName.Name

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

APIEndpointConfigurationObjectId

Gets or sets the API Endpoint Configuration object identifier.

[JsonPropertyName("api_endpoint_configuration_object_id")]
public required string APIEndpointConfigurationObjectId { get; set; }

Property Value

string

ContentPropertyName

Gets or sets the name of the property that stores the content.

[JsonPropertyName("content_property_name")]
public required string ContentPropertyName { get; set; }

Property Value

string

DatabaseName

Gets or sets the name of the vector database.

[JsonPropertyName("database_name")]
public required string DatabaseName { get; set; }

Property Value

string

DatabaseType

Gets or sets the type of the vector database.

[JsonPropertyName("database_type")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public required VectorDatabaseType DatabaseType { get; set; }

Property Value

VectorDatabaseType

EmbeddingDimensions

Gets or sets the number of dimensions for the embeddings used in the knowledge unit.

[JsonPropertyName("embedding_dimensions")]
public required int EmbeddingDimensions { get; set; }

Property Value

int

EmbeddingModel

Gets or sets the embedding model used for the knowledge unit.

[JsonPropertyName("embedding_model")]
public required string EmbeddingModel { get; set; }

Property Value

string

EmbeddingPropertyName

Gets or sets the name of the property that stores the embeddings.

[JsonPropertyName("embedding_property_name")]
public required string EmbeddingPropertyName { get; set; }

Property Value

string

MetadataProperties

Gets or sets the list of metadata properties managed by the vector database.

[JsonPropertyName("metadata_properties")]
public required string MetadataProperties { get; set; }

Property Value

string

Remarks

Must be a comma-separated list of metadata property names and types to be indexed. The name and type must be separated by '|'. For Azure AI Search databases, valid types are 'Edm.String', 'Edm.Int32', 'Edm.Int64','Edm.Single','Edm.Double','Edm.Boolean','Edm.DateTimeOffset'.

MetadataPropertyName

Gets or sets the name of the metadata property that stores additional information about each item.

[JsonPropertyName("metadata_property_name")]
public required string MetadataPropertyName { get; set; }

Property Value

string

VectorStoreIdPropertyName

Gets or sets the name of the property that stores the vector store identifier.

[JsonPropertyName("vector_store_id_property_name")]
public required string VectorStoreIdPropertyName { get; set; }

Property Value

string