Interface IVectorizationStateService

Namespace

FoundationaLLM.Vectorization.Interfaces

Assembly

FoundationaLLM.Vectorization.Engine.dll

Provides persistence services for vectorization pipeline states.

public interface IVectorizationStateService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

HasState(VectorizationRequest)

Checks if a vectorization request has a persisted vectorization state.

Task<bool> HasState(VectorizationRequest request)

Parameters

request VectorizationRequest

The VectorizationRequest object.

Returns

Task<bool>

True if a persisted state was found.

LoadArtifacts(VectorizationState, VectorizationArtifactType)

Loads into the state the specified type of artifact(s).

Task LoadArtifacts(VectorizationState state, VectorizationArtifactType artifactType)

Parameters

state VectorizationState

The vectorization state in which the artifacts will be loaded.

artifactType VectorizationArtifactType

The type of artifact(s) to load.

Returns

Task

ReadState(VectorizationRequest)

Reads the state associated with a vectorization request.

Task<VectorizationState> ReadState(VectorizationRequest request)

Parameters

request VectorizationRequest

The VectorizationRequest object..

Returns

Task<VectorizationState>

A VectorizationState item containe the requested vectorization state.

SavePipelineState(VectorizationPipelineExecution, VectorizationPipelineExecutionDetail?)

Saves the state of a vectorization pipeline execution.

Task SavePipelineState(VectorizationPipelineExecution pipelineExecution, VectorizationPipelineExecutionDetail? pipelineExecutionDetail)

Parameters

pipelineExecution VectorizationPipelineExecution

The main state of the pipeline execution.

pipelineExecutionDetail VectorizationPipelineExecutionDetail

The details associated with the main state of the pipeline execution.

Returns

Task

SaveState(VectorizationState)

Saves a specified vectorization state.

Task SaveState(VectorizationState state)

Parameters

state VectorizationState

The VectorizationState item to be saved.

Returns

Task

UpdatePipelineStateFromVectorizationRequest(VectorizationRequest)

Updates the state of a vectorization pipeline execution based on the state of the specified vectorization request.

Task UpdatePipelineStateFromVectorizationRequest(VectorizationRequest vectorizationRequest)

Parameters

vectorizationRequest VectorizationRequest

The vectorization request based on which the pipeline execution state is being updated.

Returns

Task