Table of Contents

Class VectorizationPipeline

Namespace
FoundationaLLM.Common.Models.Vectorization
Assembly
FoundationaLLM.Common.dll

Defines a vectorization pipeline.

public class VectorizationPipeline : ResourceBase
Inheritance
VectorizationPipeline
Inherited Members
Extension Methods

Constructors

VectorizationPipeline()

Set default property values.

public VectorizationPipeline()

Properties

Active

Indicates whether the pipeline is active or not. When the pipeline is inactive, it cannot be triggered to execute.

[JsonPropertyName("active")]
public bool Active { get; set; }

Property Value

bool

DataSourceObjectId

The object identifier of the data source used to retrieve content for vectorization.

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

Property Value

string

IndexingProfileObjectId

The object identifier of the indexing profile used to index text embeddings.

[JsonPropertyName("indexing_profile_object_id")]
public required string IndexingProfileObjectId { get; set; }

Property Value

string

TextEmbeddingProfileObjectId

The object identifier of the text embedding profile used to embed text.

[JsonPropertyName("text_embedding_profile_object_id")]
public required string TextEmbeddingProfileObjectId { get; set; }

Property Value

string

TextPartitioningProfileObjectId

The object identifier of the text partitioning profile used to split text.

[JsonPropertyName("text_partitioning_profile_object_id")]
public required string TextPartitioningProfileObjectId { get; set; }

Property Value

string

TriggerCronSchedule

The schedule of the trigger in Cron format. This propoerty is valid only when TriggerType = Schedule.

[JsonPropertyName("trigger_cron_schedule")]
public string? TriggerCronSchedule { get; set; }

Property Value

string

TriggerType

The type of trigger that initiates the execution of the pipeline.

[JsonPropertyName("trigger_type")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public required VectorizationPipelineTriggerType TriggerType { get; set; }

Property Value

VectorizationPipelineTriggerType