Class ContentIdentifier

Namespace

FoundationaLLM.Common.Models.Vectorization

Assembly

FoundationaLLM.Common.dll

Represents the content associated with a vectorization request.

public class ContentIdentifier

Inheritance

object

ContentIdentifier

Inherited Members

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

CanonicalId

The canonical identifier of the content being vectorized. Vectorization state services use it to derive the location of the state in the underlying storage.

[JsonPropertyOrder(2)]
[JsonPropertyName("canonical_id")]
public required string CanonicalId { get; set; }

Property Value

string

DataSourceObjectId

The name of the vectorization content source profile that provides settings to connect to the content source.

[JsonPropertyOrder(0)]
[JsonPropertyName("data_source_object_id")]
public required string DataSourceObjectId { get; set; }

Property Value

string

FileName

The file name part of the content identifier.

[JsonIgnore]
public string FileName { get; }

Property Value

string

this[int]

The indexer allowing to access the components of the multipart identifier using [] notation.

[JsonIgnore]
public string this[int i] { get; }

Parameters

i int

The index of component being retrieved.

Property Value

string

Metadata

Additional metadata associated with the content being vectorized.

[JsonPropertyOrder(3)]
[JsonPropertyName("metadata")]
public Dictionary<string, object>? Metadata { get; set; }

Property Value

Dictionary<string, object>

MultipartId

The multipart unique identifier of the the content (i.e. document) being vectorized.

[JsonInclude]
[JsonPropertyOrder(1)]
[JsonPropertyName("multipart_id")]
public required List<string> MultipartId { get; set; }

Property Value

List<string>

UniqueId

The unique identifier of the content (i.e., document) being vectorized. The identifier is determined by concatenating the parts from MultipartId.

[JsonIgnore]
public string UniqueId { get; }

Property Value

string

Methods

ValidateMultipartId(int)

Validates a multipart unique content identifier.

public void ValidateMultipartId(int expectedPartsCount)

Parameters

expectedPartsCount int

The expected number of parts in the multipart identifier.

Exceptions

ContentIdentifierException