AnalyzeBatchDocumentsOptions Class

Reference

Definition

Namespace:: Azure.AI.DocumentIntelligence

Assembly:: Azure.AI.DocumentIntelligence.dll

Package:: Azure.AI.DocumentIntelligence v1.0.0

Source:: AnalyzeBatchDocumentsOptions.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.

Batch document analysis parameters.

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

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

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

Inheritance: Object
AnalyzeBatchDocumentsOptions

Implements: IJsonModel<AnalyzeBatchDocumentsOptions> IPersistableModel<AnalyzeBatchDocumentsOptions> IPersistableModel<T>

Constructors

AnalyzeBatchDocumentsOptions(String, BlobContentSource, Uri)	Initializes a new instance of AnalyzeBatchDocumentsOptions.
AnalyzeBatchDocumentsOptions(String, BlobFileListContentSource, Uri)	Initializes a new instance of AnalyzeBatchDocumentsOptions.

Properties

BlobFileListSource	Azure Blob Storage file list specifying the batch documents.
BlobSource	Azure Blob Storage location containing the batch documents.
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.
OverwriteExisting	Overwrite existing analyze result files?.
Pages	1-based page numbers to analyze. Ex. "1-3,5,7-9".
QueryFields	List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber".
ResultContainerUri	Azure Blob Storage container URL where analyze result files will be stored.
ResultPrefix	Blob name prefix of result files.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to

共用方式為