# ChatBatchTransformation {{< rawhtml >}}

Class ChatBatchTransformation<TInput, TOutput>

Sends each batch to an Microsoft.Extensions.AI.IChatClient as one request and emits the returned rows in the order they came back. The batch is sent as {"Items":[...]} and the same envelope is expected in the response. Set RequireSameItemCount to enforce one item per input row. Default batch size is 10.

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<TOutput>
DataFlowTransformation<TInput, TOutput>
ChatBatchTransformation<TInput, TOutput>
ChatBatchTransformation
ChatBatchTransformation<TInput>
Implements
IDataFlowTransformation<TInput, TOutput>
IDataFlowSource<TOutput>
IDataFlowSource
IDataFlowDestination<TInput>
IDataFlowDestination
IDataFlowComponent
ILoggableTask
Inherited Members
DataFlowTransformation<TInput, TOutput>.TargetBlock
DataFlowTransformation<TInput, TOutput>.CompleteBuffer()
DataFlowTransformation<TInput, TOutput>.FaultBuffer(Exception)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
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.PrepareParameterForCheck()
DataFlowComponent.InitCheckedParameter()
DataFlowComponent.OnInitialization
DataFlowComponent.OnCompletion
DataFlowComponent.OnException
DataFlowComponent.CompleteOrFaultBufferOnPredecessorCompletion(Task)
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 ChatBatchTransformation : DataFlowTransformation, IDataFlowTransformation, IDataFlowSource, IDataFlowSource, IDataFlowDestination, IDataFlowDestination, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}
Type Parameters
Name Description
TInput

Type of ingoing data.
TOutput

Type of outgoing data.

Constructors

ChatBatchTransformation()

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

ChatBatchTransformation(IChatClient)

Declaration
{{< /rawhtml >}} ```C# public ChatBatchTransformation(IChatClient chatClient) ``` {{< rawhtml >}}
Parameters
Type Name Description
IChatClient chatClient

ChatBatchTransformation(IChatClient, int)

Declaration
{{< /rawhtml >}} ```C# public ChatBatchTransformation(IChatClient chatClient, int batchSize) ``` {{< rawhtml >}}
Parameters
Type Name Description
IChatClient chatClient
int batchSize

Properties

BatchSize

The number of rows sent to the chat client in one request. Default is 10.

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

ChatClient

Chat client created by the caller, for example from OpenAI or Azure OpenAI.

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

ChatOptions

Optional chat options such as model or temperature. These options are not modified. If no response format is set, a suitable one is added automatically.

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

RequireSameItemCount

If true, the response must contain exactly one item per input row, otherwise an exception is thrown. Default is false, so the chat client may return more or fewer items than the batch contains.

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

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<TOutput>
Overrides

SystemPrompt

Optional system prompt sent as a system message.

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

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

UserPrompt

Optional user prompt sent in front of the serialized batch.

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

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

CompleteBuffer()

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

FaultBuffer(Exception)

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

InitComponent()

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

Reset()

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

Implements

{{< /rawhtml >}}