DocumentExtractionClient Class

Definition

Namespace:

Microsoft.Extensions.DocumentExtraction

Assembly:

Microsoft.Extensions.DocumentExtraction.Abstractions.dll

Package:

Microsoft.Extensions.DocumentExtraction.Abstractions v11.0.0-preview.1.26560.3

Extracts a shared Documents document from a source stream.

public ref class DocumentExtractionClient abstract : IDisposable

public abstract class DocumentExtractionClient : IDisposable

type DocumentExtractionClient = class
    interface IDisposable

Public MustInherit Class DocumentExtractionClient
Implements IDisposable

Inheritance

Object

DocumentExtractionClient

Derived

Microsoft.Extensions.DocumentExtraction.DelegatingDocumentExtractionClient

Implements

IDisposable

Remarks

Implementations do not own or dispose the source stream. They must snapshot per-call options before asynchronous work, honor cancellation, and release provider resources on failure or cancellation. Cleanup failures must not replace the primary error. The returned document is data and requires no disposal. Providers explicitly populate source frames, including blank frames. Optional native document, payload and source-reference objects remain borrowed; they are not implicitly disposed or deep-cloned. The shared contract does not guarantee original HTTP bytes, response-content retention or durable serialization.

Constructors

Name	Description
DocumentExtractionClient()	Initializes a new instance of the DocumentExtractionClient class.

Methods

Name	Description
Dispose()	Releases resources owned by this client.
Dispose(Boolean)	Releases resources owned by this client.
ExtractAsync(Stream, String, String, DocumentExtractionOptions, CancellationToken)	Extracts a canonical document without requiring a separate page or observation protocol.
GetService(Type, Object)	Gets an optional service exposed by this client.