# OfficeAiRequest

Document operation parameters. Collections are snapshotted before asynchronous work starts.

Class 

`OfficeIMO.AI`

**Namespace**

`OfficeIMO.AI`

**Assembly**

`OfficeIMO.AI`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeAiOperation.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L39)

**Implements**

`IEquatable<OfficeAiRequest>`

**Modifiers**

sealed

Document operation parameters. Collections are snapshotted before asynchronous work starts.

## Inheritance

- object
- OfficeAiRequest

## 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 1

- Method [OfficeAiRequest.<Clone>$](/api/ai/officeimo-ai-officeairequest/#method-clone)

### Accepted by parameters 6

- Method [OfficeAiEngine.RunAsync](/api/ai/officeimo-ai-officeaiengine/#method-runasync-officeimo-ai-officeaidocument-officeimo-ai-officeairequest-iprogress-officeimo-ai-officeaiprogress-threading-cancellationtoken) parameter `request`
- Method [OfficeAiRequest.Equals](/api/ai/officeimo-ai-officeairequest/#method-equals-officeairequest) parameter `other`
- Method [OfficeAiRequest.op_Equality](/api/ai/officeimo-ai-officeairequest/#method-op-equality-officeairequest-officeairequest) parameter `left`
- Method [OfficeAiRequest.op_Equality](/api/ai/officeimo-ai-officeairequest/#method-op-equality-officeairequest-officeairequest) parameter `right`
- Method [OfficeAiRequest.op_Inequality](/api/ai/officeimo-ai-officeairequest/#method-op-inequality-officeairequest-officeairequest) parameter `left`
- Method [OfficeAiRequest.op_Inequality](/api/ai/officeimo-ai-officeairequest/#method-op-inequality-officeairequest-officeairequest) parameter `right`

Filter members 

Show inherited

## Constructors

`public OfficeAiRequest()` [#](#constructor-ctor)

[OfficeAiOperation.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L39)

## Methods

`public OfficeAiRequest <Clone>$()` [#](#method-clone)

Returns

`OfficeAiRequest`

Equals 2 overloads

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

Parameters

**obj object? required**

Returns

`bool`

`public bool Equals(OfficeAiRequest? other)` [#](#method-equals-officeairequest)

Parameters

**other OfficeAiRequest? required**

Returns

`bool`

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

Returns

`int`

`public static bool op_Equality(OfficeAiRequest? left, OfficeAiRequest? right)` [#](#method-op-equality-officeairequest-officeairequest)

Parameters

**left OfficeAiRequest? required**

**right OfficeAiRequest? required**

Returns

`bool`

`public static bool op_Inequality(OfficeAiRequest? left, OfficeAiRequest? right)` [#](#method-op-inequality-officeairequest-officeairequest)

Parameters

**left OfficeAiRequest? required**

**right OfficeAiRequest? required**

Returns

`bool`

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

Returns

`string`

## Inherited Methods

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

Inherited from object

Returns

`Type`

## Properties

`public OfficeAiOperation Operation { get; init; }` [#](#property-operation)

[OfficeAiOperation.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L37)

Requested read-only operation.

`public string Instruction { get; init; }` [#](#property-instruction)

[OfficeAiOperation.cs:39](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L39)

Question or extraction instruction, distinct from untrusted document evidence.

`public string ConversationContext { get; init; }` [#](#property-conversationcontext)

[OfficeAiOperation.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L41)

Optional bounded prior discussion for resolving follow-up wording. It is untrusted context, never source evidence.

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

[OfficeAiOperation.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L43)

Explicit one-based pages, or an empty list for the whole captured source.

`public IReadOnlyList<string> EvidenceIds { get; init; }` [#](#property-evidenceids)

[OfficeAiOperation.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L45)

Explicit evidence identifiers, or an empty list for all evidence in the page scope.

`public IReadOnlyList<OfficeAiFieldDefinition> Fields { get; init; }` [#](#property-fields)

[OfficeAiOperation.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L47)

Field requirements for ExtractFields.

`public string Culture { get; init; }` [#](#property-culture)

[OfficeAiOperation.cs:49](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L49)

Culture for deterministic scalar normalization. Invariant culture is the default.

`public bool IncludeImages { get; init; }` [#](#property-includeimages)

[OfficeAiOperation.cs:51](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L51)

Allows selected source images to leave the source boundary through the configured executor.

`public bool AllowRemoteProcessing { get; init; }` [#](#property-allowremoteprocessing)

[OfficeAiOperation.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L53)

Explicit authorization to send selected evidence to a non-local execution profile.

`public OfficeAiLimits Limits { get; init; }` [#](#property-limits)

[OfficeAiOperation.cs:55](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.AI/OfficeAiOperation.cs#L55)

Whole-operation resource bounds.

<!-- PowerForge markdown artifact sha256:F73FFB08AD491F04DD5B5F4C44CFD423898B56C5B65A4B8D92C420C4DB4A7220 -->
