Table of Contents

Class VectorDatabase

Namespace
FoundationaLLM.Common.Models.ResourceProviders.Vector
Assembly
FoundationaLLM.Common.dll

Represents a vector database resource.

public class VectorDatabase : ResourceBase
Inheritance
VectorDatabase
Inherited Members
Extension Methods

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

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

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
Edit this page