Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeAiRequest

OfficeIMO.AI

Namespace
OfficeIMO.AI
Assembly
OfficeIMO.AI
Source revision
ba882f6b0d07 with working tree changes
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

Accepted by parameters 6

Constructors

public OfficeAiRequest() #

Methods

public OfficeAiRequest <Clone>$() #
Equals 2 overloads
public override bool Equals(object? obj) #

Parameters

obj object? required

Returns

bool
public bool Equals(OfficeAiRequest? other) #

Parameters

other OfficeAiRequest? required

Returns

bool
public override int GetHashCode() #

Returns

int
public static bool op_Equality(OfficeAiRequest? left, OfficeAiRequest? right) #

Parameters

left OfficeAiRequest? required
right OfficeAiRequest? required

Returns

bool
public static bool op_Inequality(OfficeAiRequest? left, OfficeAiRequest? right) #

Parameters

left OfficeAiRequest? required
right OfficeAiRequest? required

Returns

bool
public override string ToString() #

Returns

string

Properties

public OfficeAiOperation Operation { get; init; } #

Requested read-only operation.

public string Instruction { get; init; } #

Question or extraction instruction, distinct from untrusted document evidence.

public string ConversationContext { get; init; } #

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

public IReadOnlyList<int> Pages { get; init; } #

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

public IReadOnlyList<string> EvidenceIds { get; init; } #

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

public IReadOnlyList<OfficeAiFieldDefinition> Fields { get; init; } #

Field requirements for ExtractFields.

public string Culture { get; init; } #

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

public bool IncludeImages { get; init; } #

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

public bool AllowRemoteProcessing { get; init; } #

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

public OfficeAiLimits Limits { get; init; } #

Whole-operation resource bounds.