AnalyzeDocumentOptions Class

Reference

Definition

Namespace:: Azure.AI.DocumentIntelligence

Assembly:: Azure.AI.DocumentIntelligence.dll

Package:: Azure.AI.DocumentIntelligence v1.0.0

Source:: AnalyzeDocumentOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Document analysis parameters.

public class AnalyzeDocumentOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.DocumentIntelligence.AnalyzeDocumentOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.DocumentIntelligence.AnalyzeDocumentOptions>

type AnalyzeDocumentOptions = class
    interface IJsonModel<AnalyzeDocumentOptions>
    interface IPersistableModel<AnalyzeDocumentOptions>

Public Class AnalyzeDocumentOptions
Implements IJsonModel(Of AnalyzeDocumentOptions), IPersistableModel(Of AnalyzeDocumentOptions)

Inheritance: Object
AnalyzeDocumentOptions

Implements: IJsonModel<AnalyzeDocumentOptions> IPersistableModel<AnalyzeDocumentOptions> IPersistableModel<T>

Constructors

AnalyzeDocumentOptions(String, BinaryData)	Initializes a new instance of AnalyzeDocumentOptions.
AnalyzeDocumentOptions(String, Uri)	Initializes a new instance of AnalyzeDocumentOptions.

Properties

BytesSource	Bytes of the document to analyze. To assign a byte[] to this property use FromBytes(Byte[]). The byte[] will be serialized to a Base64 encoded string. Examples: BinaryData.FromBytes(new byte[] { 1, 2, 3 }): Creates a payload of "AQID".
Features	List of optional analysis features.
Locale	Locale hint for text recognition and document analysis. Value may contain only the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").
ModelId	Unique document model name.
Output	Additional outputs to generate during analysis.
OutputContentFormat	Format of the analyze result top-level content.
Pages	1-based page numbers to analyze. Ex. "1-3,5,7-9".
QueryFields	List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".
UriSource	Document URL to analyze.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<AnalyzeDocumentOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AnalyzeDocumentOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AnalyzeDocumentOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AnalyzeDocumentOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AnalyzeDocumentOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Partager via