# EmbeddingTransformation {{< rawhtml >}}

Class EmbeddingTransformation<TInput>

Creates an embedding for each row and writes the vector back into the same row object. The text is read via TextSelector (or the EmbeddingText attribute), the vector is written via VectorSetter (or the EmbeddingVector attribute).

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<TInput>
DataFlowTransformation<TInput, TInput>
EmbeddingTransformation<TInput>
EmbeddingTransformation
Implements
IDataFlowTransformation<TInput, TInput>
IDataFlowSource<TInput>
IDataFlowSource
IDataFlowDestination<TInput>
IDataFlowDestination
IDataFlowComponent
ILoggableTask
Inherited Members
DataFlowTransformation<TInput, TInput>.TargetBlock
DataFlowTransformation<TInput, TInput>.CompleteBuffer()
DataFlowTransformation<TInput, TInput>.FaultBuffer(Exception)
DataFlowSource<TInput>.LinkTo(IDataFlowDestination<TInput>)
DataFlowSource<TInput>.LinkTo(IDataFlowDestination<TInput>, Predicate<TInput>)
DataFlowSource<TInput>.LinkTo(IDataFlowDestination<TInput>, Predicate<TInput>, Predicate<TInput>)
DataFlowSource<TInput>.LinkTo<TConvert>(IDataFlowDestination<TInput>)
DataFlowSource<TInput>.LinkTo<TConvert>(IDataFlowDestination<TInput>, Predicate<TInput>)
DataFlowSource<TInput>.LinkTo<TConvert>(IDataFlowDestination<TInput>, Predicate<TInput>, Predicate<TInput>)
DataFlowComponent.MaxBufferSize
DataFlowComponent.Predecessors
DataFlowComponent.Successors
DataFlowComponent.Completion
DataFlowComponent.BufferCancellationSource
DataFlowComponent.BufferCancellationToken
DataFlowComponent.WasComponentInitialized
DataFlowComponent.IsReadyForProcessing
DataFlowComponent.SetParentComponent(DataFlowComponent)
DataFlowComponent.LinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.InternalLinkTo<T>(IDataFlowDestination, object, object)
DataFlowComponent.AddComplementVoidLinkToOtherTargets(Func<Type, IDataFlowDestination>, Delegate)
DataFlowComponent.ResetComponent()
DataFlowComponent.InitBufferObjects(CancellationToken?)
DataFlowComponent.InitCheckedParameter()
DataFlowComponent.OnInitialization
DataFlowComponent.OnCompletion
DataFlowComponent.OnException
DataFlowComponent.CompleteOrFaultBufferOnPredecessorCompletion(Task)
DataFlowComponent.CompleteBuffer()
DataFlowComponent.FaultBuffer(Exception)
DataFlowComponent.Exception
DataFlowComponent.ErrorSource
DataFlowComponent.CancelBufferAndThrowOperationCanceledException()
DataFlowComponent.InternalLinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.ThrowOrRedirectError(Exception, string, string)
DataFlowComponent.ThrowErrorAndFaultNetwork(Exception, string)
DataFlowComponent.CancelComponent()
DataFlowComponent.ErrorCount
DataFlowComponent.ProgressCount
DataFlowComponent.OnProgress
DataFlowComponent.ExecutionStartTime
DataFlowComponent.ExecutionEndTime
DataFlowComponent.Tag
DataFlowComponent.LoggingStartOnce()
DataFlowComponent.LoggingFinishOnce()
DataFlowComponent.LogProgressBatch_AfterThrowOrRedirectError(int)
DataFlowComponent.LogProgress_AfterThrowOrRedirectError()
LoggableTask.TaskType
LoggableTask.TaskName
LoggableTask.DisableLogging
LoggableTask.LogThreshold
LoggableTask.TaskHash
LoggableTask.LogInstance
LoggableTask.ParentTask
LoggableTask.LogTrace(string, params object[])
LoggableTask.LogDebug(string, params object[])
LoggableTask.LogInfo(string, params object[])
LoggableTask.LogInfoOrDebug(string, params object[])
LoggableTask.LogWarn(string, params object[])
LoggableTask.LogError(string, params object[])
LoggableTask.LogFatal(string, params object[])
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.AI
Assembly: ETLBox.AI.dll
Syntax
{{< /rawhtml >}} ```C# public class EmbeddingTransformation : DataFlowTransformation, IDataFlowTransformation, IDataFlowSource, IDataFlowSource, IDataFlowDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}
Type Parameters
Name Description
TInput

Type of ingoing and outgoing data.

Constructors

EmbeddingTransformation()

Declaration
{{< /rawhtml >}} ```C# public EmbeddingTransformation() ``` {{< rawhtml >}}

EmbeddingTransformation(IEmbeddingGenerator<string, Embedding<float>>)

Declaration
{{< /rawhtml >}} ```C# public EmbeddingTransformation(IEmbeddingGenerator> embeddingGenerator) ``` {{< rawhtml >}}
Parameters
Type Name Description
IEmbeddingGenerator<string, Embedding<float>> embeddingGenerator

Properties

EmbeddingGenerationOptions

Optional options passed to the embedding generator, e.g. model id or dimensions.

Declaration
{{< /rawhtml >}} ```C# public EmbeddingGenerationOptions EmbeddingGenerationOptions { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
EmbeddingGenerationOptions

EmbeddingGenerator

Embedding generator created by the caller.

Declaration
{{< /rawhtml >}} ```C# public IEmbeddingGenerator> EmbeddingGenerator { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
IEmbeddingGenerator<string, Embedding<float>>

SourceBlock

SourceBlock from the underlying TPL.Dataflow which is used as output buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ISourceBlock SourceBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ISourceBlock<TInput>
Overrides

TargetBlock

TargetBlock from the underlying TPL.Dataflow which is used as input buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ITargetBlock TargetBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ITargetBlock<TInput>
Overrides

TextPropertyName

Only for ExpandoObject: property that contains the text to embed. Default is "Text".

Declaration
{{< /rawhtml >}} ```C# public string TextPropertyName { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
string

TextSelector

Selects the text that is sent to the embedding generator.

Declaration
{{< /rawhtml >}} ```C# public Func TextSelector { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Func<TInput, string>

VectorPropertyName

Only for ExpandoObject: property that receives the vector. Default is "Embedding".

Declaration
{{< /rawhtml >}} ```C# public string VectorPropertyName { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
string

VectorSetter

Writes the returned vector into the row.

Declaration
{{< /rawhtml >}} ```C# public Action> VectorSetter { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
Action<TInput, ReadOnlyMemory<float>>

Methods

CheckParameter()

Declaration
{{< /rawhtml >}} ```C# protected override void CheckParameter() ``` {{< rawhtml >}}
Overrides

CleanUpOnFaulted(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnFaulted(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

CleanUpOnSuccess()

Declaration
{{< /rawhtml >}} ```C# protected override void CleanUpOnSuccess() ``` {{< rawhtml >}}
Overrides

InitComponent()

Declaration
{{< /rawhtml >}} ```C# protected override void InitComponent() ``` {{< rawhtml >}}
Overrides

PrepareParameterForCheck()

Declaration
{{< /rawhtml >}} ```C# protected override void PrepareParameterForCheck() ``` {{< rawhtml >}}
Overrides

Reset()

Declaration
{{< /rawhtml >}} ```C# protected override void Reset() ``` {{< rawhtml >}}
Overrides

Implements

{{< /rawhtml >}}