API Reference
OfficeAiRequest
Document operation parameters. Collections are snapshotted before asynchronous work starts.
Inheritance
- Object
- OfficeAiRequest
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method OfficeAiRequest.<Clone>$
Accepted by parameters
- Method OfficeAiEngine.RunAsync
- Method OfficeAiRequest.Equals
- Method OfficeAiRequest.op_Equality
- Method OfficeAiRequest.op_Equality
- Method OfficeAiRequest.op_Inequality
- Method OfficeAiRequest.op_Inequality
Constructors
public OfficeAiRequest() #Methods
public OfficeAiRequest <Clone>$() #OfficeAiRequestpublic override Int32 GetHashCode() #Int32public static Boolean op_Equality(OfficeAiRequest left, OfficeAiRequest right) #BooleanParameters
- left OfficeAiRequest
- right OfficeAiRequest
public static Boolean op_Inequality(OfficeAiRequest left, OfficeAiRequest right) #BooleanParameters
- left OfficeAiRequest
- right OfficeAiRequest
public override String ToString() #StringInherited Methods
Properties
public OfficeAiOperation Operation { get; set; } #Requested read-only operation.
public String Instruction { get; set; } #Question or extraction instruction, distinct from untrusted document evidence.
public String ConversationContext { get; set; } #Optional bounded prior discussion for resolving follow-up wording. It is untrusted context, never source evidence.
public IReadOnlyList<Int32> Pages { get; set; } #Explicit one-based pages, or an empty list for the whole captured source.
public IReadOnlyList<String> EvidenceIds { get; set; } #Explicit evidence identifiers, or an empty list for all evidence in the page scope.
public IReadOnlyList<OfficeAiFieldDefinition> Fields { get; set; } #Field requirements for ExtractFields.
public String Culture { get; set; } #Culture for deterministic scalar normalization. Invariant culture is the default.
public Boolean IncludeImages { get; set; } #Allows selected source images to leave the source boundary through the configured executor.
public Boolean AllowRemoteProcessing { get; set; } #Explicit authorization to send selected evidence to a non-local execution profile.
public OfficeAiLimits Limits { get; set; } #Whole-operation resource bounds.