# OfficeAiDocument

Immutable bounded source evidence. Original Reader objects and caller streams are not retained.

Class 

`OfficeIMO.AI`

**Namespace**

`OfficeIMO.AI`

**Assembly**

`OfficeIMO.AI`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeAiDocument.cs:84](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L84)

**Modifiers**

sealed

Immutable bounded source evidence. Original Reader objects and caller streams are not retained.

## Inheritance

- object
- OfficeAiDocument

## Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 2

- Method [OfficeAiDocument.FromReadResult](/api/ai/officeimo-ai-officeaidocument/#method-fromreadresult-byte-officeimo-reader-officedocumentreadresult-collections-generic-ienumerable-officeimo-ai-officeaiimage-officeimo-ai-officeailimits)
- Method [OfficeAiDocument.ReadAsync](/api/ai/officeimo-ai-officeaidocument/#method-readasync-officeimo-reader-officedocumentreader-io-stream-string-officeimo-ai-officeailimits-officeimo-reader-readeroptions-threading-cancellationtoken)

### Accepted by parameters 5

- Method [OfficeAiArtifacts.CreateProposedReadResult](/api/ai/officeimo-ai-officeaiartifacts/#method-createproposedreadresult-officeimo-ai-officeaidocument-officeimo-ai-officeairesult) parameter `document`
- Method [OfficeAiArtifacts.FormatAnswer](/api/ai/officeimo-ai-officeaiartifacts/#method-formatanswer-officeimo-ai-officeaidocument-officeimo-ai-officeairesult-string-string) parameter `document`
- Method [OfficeAiArtifacts.SerializeReport](/api/ai/officeimo-ai-officeaiartifacts/#method-serializereport-officeimo-ai-officeaidocument-officeimo-ai-officeairesult) parameter `document`
- Method [OfficeAiEngine.RunAsync](/api/ai/officeimo-ai-officeaiengine/#method-runasync-officeimo-ai-officeaidocument-officeimo-ai-officeairequest-iprogress-officeimo-ai-officeaiprogress-threading-cancellationtoken) parameter `document`
- Method [OfficeAiEvidenceReadiness.Inspect](/api/ai/officeimo-ai-officeaievidencereadiness/#method-inspect-officeimo-ai-officeaidocument-collections-generic-ienumerable-system-int32) parameter `document`

Filter members 

Show inherited

## Methods

`public static OfficeAiDocument FromReadResult(byte[] sourceBytes, OfficeDocumentReadResult document, IEnumerable<OfficeAiImage>? images = null, OfficeAiLimits? limits = null)` [#](#method-fromreadresult-byte-officeimo-reader-officedocumentreadresult-collections-generic-ienumerable-officeimo-ai-officeaiimage-officeimo-ai-officeailimits)

[OfficeAiDocument.cs:84](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L84)

Captures a trusted adapter's read result and optional page images for the supplied original bytes. The adapter must enforce source permissions and ensure readback/images describe those bytes. This method copies observations; later mutations of the Reader result cannot change evidence.

Parameters

**sourceBytes byte[] required**

**document OfficeIMO.Reader.OfficeDocumentReadResult required**

**images System.Collections.Generic.IEnumerable<OfficeIMO.AI.OfficeAiImage>? = null optional**

**limits OfficeIMO.AI.OfficeAiLimits? = null optional**

Returns

`OfficeAiDocument`

`public static async Task<OfficeAiDocument> ReadAsync(OfficeDocumentReader reader, Stream source, string sourceName, OfficeAiLimits? limits = null, ReaderOptions? readerOptions = null, CancellationToken cancellationToken = default)` [#](#method-readasync-officeimo-reader-officedocumentreader-io-stream-string-officeimo-ai-officeailimits-officeimo-reader-readeroptions-threading-cancellationtoken)

Reads and fingerprints a bounded source snapshot. The caller retains ownership of the stream.

Parameters

**reader OfficeIMO.Reader.OfficeDocumentReader required**

**source System.IO.Stream required**

**sourceName string required**

**limits OfficeIMO.AI.OfficeAiLimits? = null optional**

**readerOptions OfficeIMO.Reader.ReaderOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeAiDocument>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string SourceHash { get; }` [#](#property-sourcehash)

[OfficeAiDocument.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L40)

SHA-256 of the exact captured source bytes.

`public string SnapshotHash { get; }` [#](#property-snapshothash)

[OfficeAiDocument.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L42)

SHA-256 binding source bytes to this exact evidence projection, page metadata, image payload identities and coverage state.

`public int SourceByteLength { get; }` [#](#property-sourcebytelength)

[OfficeAiDocument.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L44)

Number of original bytes captured for this snapshot.

`public IReadOnlyList<OfficeAiEvidence> Evidence { get; }` [#](#property-evidence)

[OfficeAiDocument.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L46)

Immutable text observations in source order.

`public IReadOnlyList<int> Pages { get; }` [#](#property-pages)

[OfficeAiDocument.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L48)

All known one-based pages, including pages without text.

`public IReadOnlyList<OfficeAiImage> Images { get; }` [#](#property-images)

[OfficeAiDocument.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L50)

Explicit inline images supplied by the source/rendering owner.

`public string PageProvenance { get; }` [#](#property-pageprovenance)

[OfficeAiDocument.cs:52](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L52)

Reader's native/computed/explicit/unknown page provenance.

`public bool HasSourceDiagnostics { get; }` [#](#property-hassourcediagnostics)

[OfficeAiDocument.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiDocument.cs#L54)

True when the source or a nested document reports limitations, pending OCR or truncated content; AI cannot certify complete source reconstruction.

<!-- PowerForge markdown artifact sha256:6FB82F11C5FBD432C25B10E0652820ED70583F2D561E473116AEDDB2D85E69C3 -->
