Method ConvertAsync

Namespace

LMKit.Document.Conversion

Assembly

LM-Kit.NET.dll

ConvertAsync(string, DocumentToMarkdownOptions, CancellationToken)

Asynchronously converts the document at inputPath to Markdown.

public Task<DocumentToMarkdownResult> ConvertAsync(string inputPath, DocumentToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

inputPath string

options DocumentToMarkdownOptions

cancellation CancellationToken

Returns

Task<DocumentToMarkdownResult>

ConvertAsync(byte[], string, DocumentToMarkdownOptions, CancellationToken)

Asynchronously converts in-memory document bytes to Markdown.

public Task<DocumentToMarkdownResult> ConvertAsync(byte[] data, string fileName, DocumentToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

data byte[]

fileName string

options DocumentToMarkdownOptions

cancellation CancellationToken

Returns

Task<DocumentToMarkdownResult>

ConvertAsync(Stream, string, DocumentToMarkdownOptions, CancellationToken)

Asynchronously converts a document read from the specified stream to Markdown.

public Task<DocumentToMarkdownResult> ConvertAsync(Stream stream, string fileName, DocumentToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

stream Stream

fileName string

options DocumentToMarkdownOptions

cancellation CancellationToken

Returns

Task<DocumentToMarkdownResult>

ConvertAsync(ImageBuffer, DocumentToMarkdownOptions, CancellationToken)

Asynchronously converts a single in-memory image to Markdown using the vision OCR strategy.

public Task<DocumentToMarkdownResult> ConvertAsync(ImageBuffer image, DocumentToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

image ImageBuffer

options DocumentToMarkdownOptions

cancellation CancellationToken

Returns

Task<DocumentToMarkdownResult>

ConvertAsync(Uri, DocumentToMarkdownOptions, CancellationToken)

Asynchronously downloads the document at the specified uri and converts it to Markdown.

public Task<DocumentToMarkdownResult> ConvertAsync(Uri uri, DocumentToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

uri Uri

options DocumentToMarkdownOptions

cancellation CancellationToken

Returns

Task<DocumentToMarkdownResult>

ConvertAsync(Attachment, DocumentToMarkdownOptions, CancellationToken)

Asynchronously converts the supplied Attachment to Markdown.

public Task<DocumentToMarkdownResult> ConvertAsync(Attachment attachment, DocumentToMarkdownOptions options = null, CancellationToken cancellation = default)

Parameters

attachment Attachment

options DocumentToMarkdownOptions

cancellation CancellationToken

Returns

Task<DocumentToMarkdownResult>