HeaderChunker.xml

<Type Name="HeaderChunker" FullName="Microsoft.Extensions.DataIngestion.HeaderChunker">
  <TypeSignature Language="C#" Value="public sealed class HeaderChunker : Microsoft.Extensions.DataIngestion.IngestionChunker&lt;string&gt;" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HeaderChunker extends Microsoft.Extensions.DataIngestion.IngestionChunker`1&lt;string&gt;" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.DataIngestion.HeaderChunker" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class HeaderChunker&#xA;Inherits IngestionChunker(Of String)" />
  <TypeSignature Language="F#" Value="type HeaderChunker = class&#xA;    inherit IngestionChunker&lt;string&gt;" />
  <TypeSignature Language="C++ CLI" Value="public ref class HeaderChunker sealed : Microsoft::Extensions::DataIngestion::IngestionChunker&lt;System::String ^&gt;" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.DataIngestion</AssemblyName>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.1.0.0</AssemblyVersion>
    <AssemblyVersion>10.2.0.0</AssemblyVersion>
    <AssemblyVersion>10.3.0.0</AssemblyVersion>
    <AssemblyVersion>10.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Microsoft.Extensions.DataIngestion.IngestionChunker&lt;System.String&gt;</BaseTypeName>
    <BaseTypeArguments>
      <BaseTypeArgument TypeParamName="!0">System.String</BaseTypeArgument>
    </BaseTypeArguments>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="net-10.0-pp;net-11.0-pp;net-8.0-pp;net-9.0-pp">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Splits documents into chunks based on headers and their corresponding levels, preserving the header context.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public HeaderChunker (Microsoft.Extensions.DataIngestion.IngestionChunkerOptions options);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Extensions.DataIngestion.IngestionChunkerOptions options) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.DataIngestion.HeaderChunker.#ctor(Microsoft.Extensions.DataIngestion.IngestionChunkerOptions)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (options As IngestionChunkerOptions)" />
      <MemberSignature Language="F#" Value="new Microsoft.Extensions.DataIngestion.HeaderChunker : Microsoft.Extensions.DataIngestion.IngestionChunkerOptions -&gt; Microsoft.Extensions.DataIngestion.HeaderChunker" Usage="new Microsoft.Extensions.DataIngestion.HeaderChunker options" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; HeaderChunker(Microsoft::Extensions::DataIngestion::IngestionChunkerOptions ^ options);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.DataIngestion</AssemblyName>
        <AssemblyVersion>10.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="options" Type="Microsoft.Extensions.DataIngestion.IngestionChunkerOptions" />
      </Parameters>
      <Docs>
        <param name="options">The options for the chunker.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Extensions.DataIngestion.HeaderChunker" /> class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ProcessAsync">
      <MemberSignature Language="C#" Value="public override System.Collections.Generic.IAsyncEnumerable&lt;Microsoft.Extensions.DataIngestion.IngestionChunk&lt;string&gt;&gt; ProcessAsync (Microsoft.Extensions.DataIngestion.IngestionDocument document, System.Threading.CancellationToken cancellationToken = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Collections.Generic.IAsyncEnumerable`1&lt;class Microsoft.Extensions.DataIngestion.IngestionChunk`1&lt;string&gt;&gt; ProcessAsync(class Microsoft.Extensions.DataIngestion.IngestionDocument document, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.DataIngestion.HeaderChunker.ProcessAsync(Microsoft.Extensions.DataIngestion.IngestionDocument,System.Threading.CancellationToken)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ProcessAsync (document As IngestionDocument, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of IngestionChunk(Of String))" />
      <MemberSignature Language="F#" Value="override this.ProcessAsync : Microsoft.Extensions.DataIngestion.IngestionDocument * System.Threading.CancellationToken -&gt; System.Collections.Generic.IAsyncEnumerable&lt;Microsoft.Extensions.DataIngestion.IngestionChunk&lt;string&gt;&gt;" Usage="headerChunker.ProcessAsync (document, cancellationToken)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.DataIngestion</AssemblyName>
        <AssemblyVersion>10.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Microsoft.Extensions.DataIngestion.HeaderChunker+&lt;ProcessAsync&gt;d__3))]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.AsyncIteratorStateMachine(typeof(Microsoft.Extensions.DataIngestion.HeaderChunker+&lt;ProcessAsync&gt;d__3))&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IAsyncEnumerable&lt;Microsoft.Extensions.DataIngestion.IngestionChunk&lt;System.String&gt;&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="document" Type="Microsoft.Extensions.DataIngestion.IngestionDocument" />
        <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.Runtime.CompilerServices.EnumeratorCancellation]</AttributeName>
              <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.EnumeratorCancellation&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="document">To be added.</param>
        <param name="cancellationToken">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
  </Members>
</Type>