DocumentIntelligenceAsyncClient Class
- java.
lang. Object - com.
azure. ai. documentintelligence. DocumentIntelligenceAsyncClient
- com.
public final class DocumentIntelligenceAsyncClient
Initializes a new instance of the asynchronous DocumentIntelligenceClient type.
Method Summary
Methods inherited from java.lang.Object
Method Details
beginAnalyzeBatchDocuments
public PollerFlux
/** Analyzes batch documents with document model.
Parameters:
Returns:
beginAnalyzeBatchDocuments
public PollerFlux
Analyzes batch documents with document model.
Query Parameters
| ------------------- | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Required | Description |
| pages | String | No | 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | 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"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
| output | List<String> | No | Additional outputs to generate during analysis. In the form of "," separated string. |
You can add these to a request with RequestOptions#addQueryParam
Request Body Schema
{
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
resultContainerUrl: String (Required)
resultPrefix: String (Optional)
overwriteExisting: Boolean (Optional)
}
Parameters:
Returns:
beginAnalyzeDocument
public PollerFlux
/** Analyzes document with document model.
Parameters:
Returns:
beginAnalyzeDocument
public PollerFlux
Analyzes document with document model.
Query Parameters
| ------------------- | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Required | Description |
| pages | String | No | 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
| locale | String | No | 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"). |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| features | List<String> | No | List of optional analysis features. In the form of "," separated string. |
| queryFields | List<String> | No | List of additional fields to extract. Ex. "NumberOfGuests,StoreNumber". In the form of "," separated string. |
| outputContentFormat | String | No | Format of the analyze result top-level content. Allowed values: "text", "markdown". |
| output | List<String> | No | Additional outputs to generate during analysis. In the form of "," separated string. |
You can add these to a request with RequestOptions#addQueryParam
Request Body Schema
{
urlSource: String (Optional)
base64Source: byte[] (Optional)
}
Parameters:
Returns:
beginClassifyDocument
public PollerFlux
/** Classifies document with document classifier.
Parameters:
Returns:
beginClassifyDocument
public PollerFlux
Classifies document with document classifier.
Query Parameters
| --------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Required | Description |
| stringIndexType | String | No | Method used to compute string offset and length. Allowed values: "textElements", "unicodeCodePoint", "utf16CodeUnit". |
| split | String | No | Document splitting mode. Allowed values: "auto", "none", "perPage". |
| pages | String | No | 1-based page numbers to analyze. Ex. "1-3,5,7-9" |
You can add these to a request with RequestOptions#addQueryParam
Request Body Schema
{
urlSource: String (Optional)
base64Source: byte[] (Optional)
}
Parameters:
Returns:
deleteAnalyzeBatchResult
public Mono
Mark the batch document analysis result for deletion.
Parameters:
Returns:
deleteAnalyzeBatchResultWithResponse
public Mono
Mark the batch document analysis result for deletion.
Parameters:
Returns:
deleteAnalyzeResult
public Mono
Mark the result of document analysis for deletion.
Parameters:
Returns:
deleteAnalyzeResultWithResponse
public Mono
Mark the result of document analysis for deletion.
Parameters:
Returns:
getAnalyzeBatchResult
public Mono
Gets the result of batch document analysis.
Parameters:
Returns:
getAnalyzeBatchResultWithResponse
public Mono
Gets the result of batch document analysis.
Response Body Schema
{
resultId: String (Optional)
status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
createdDateTime: OffsetDateTime (Required)
lastUpdatedDateTime: OffsetDateTime (Required)
percentCompleted: Integer (Optional)
error (Optional): {
code: String (Required)
message: String (Required)
target: String (Optional)
details (Optional): [
(recursive schema, see above)
]
innererror (Optional): {
code: String (Optional)
message: String (Optional)
innererror (Optional): (recursive schema, see innererror above)
}
}
result (Optional): {
succeededCount: int (Required)
failedCount: int (Required)
skippedCount: int (Required)
details (Optional): [
(Optional){
status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
sourceUrl: String (Required)
resultUrl: String (Optional)
error (Optional): (recursive schema, see error above)
}
]
}
}
Parameters:
Returns:
getAnalyzeResultFigure
public Mono
Gets the generated cropped image of specified figure from document analysis.
Parameters:
Returns:
getAnalyzeResultFigureWithResponse
public Mono
Gets the generated cropped image of specified figure from document analysis.
Response Body Schema
BinaryData
Parameters:
Returns:
getAnalyzeResultPdf
public Mono
Gets the generated searchable PDF output from document analysis.
Parameters:
Returns:
getAnalyzeResultPdfWithResponse
public Mono
Gets the generated searchable PDF output from document analysis.
Response Body Schema
BinaryData
Parameters:
Returns:
listAnalyzeBatchResults
public PagedFlux
List batch document analysis results.
Parameters:
Returns:
listAnalyzeBatchResults
public PagedFlux
List batch document analysis results.
Response Body Schema
{
resultId: String (Optional)
status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
createdDateTime: OffsetDateTime (Required)
lastUpdatedDateTime: OffsetDateTime (Required)
percentCompleted: Integer (Optional)
error (Optional): {
code: String (Required)
message: String (Required)
target: String (Optional)
details (Optional): [
(recursive schema, see above)
]
innererror (Optional): {
code: String (Optional)
message: String (Optional)
innererror (Optional): (recursive schema, see innererror above)
}
}
result (Optional): {
succeededCount: int (Required)
failedCount: int (Required)
skippedCount: int (Required)
details (Optional): [
(Optional){
status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
sourceUrl: String (Required)
resultUrl: String (Optional)
error (Optional): (recursive schema, see error above)
}
]
}
}
Parameters:
Returns:
Applies to
Azure SDK for Java