forked from Azure/azure-docs-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcom.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl.yml
42 lines (42 loc) · 7.24 KB
/
com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
### YamlMime:JavaMember
uid: "com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl*"
fullName: "com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl"
name: "beginRecognizeContentFromUrl"
nameWithType: "FormRecognizerClient.beginRecognizeContentFromUrl"
members:
- uid: "com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl(java.lang.String)"
fullName: "com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl(String formUrl)"
name: "beginRecognizeContentFromUrl(String formUrl)"
nameWithType: "FormRecognizerClient.beginRecognizeContentFromUrl(String formUrl)"
summary: "Recognizes content/layout data from documents using optical character recognition (OCR).\n\nThe service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.\n\n**Code sample**\n\n```java\nString formUrl = \"{form_url}\";\n formRecognizerClient.beginRecognizeContentFromUrl(formUrl)\n .getFinalResult()\n .forEach(formPage -> {\n System.out.printf(\"Page Angle: %s%n\", formPage.getTextAngle());\n System.out.printf(\"Page Dimension unit: %s%n\", formPage.getUnit());\n // Table information\n System.out.println(\"Recognized Tables: \");\n formPage.getTables()\n .stream()\n .flatMap(formTable -> formTable.getCells().stream())\n .forEach(recognizedTableCell -> System.out.printf(\"%s \", recognizedTableCell.getText()));\n });\n```"
parameters:
- description: "The URL of the form to analyze."
name: "formUrl"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SyncPoller<FormRecognizerOperationResult,List<FormPage>> beginRecognizeContentFromUrl(String formUrl)"
returns:
description: "A <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> that polls the recognize content form operation until it has completed, has failed,\n or has been cancelled. The completed operation returns a list of <xref uid=\"com.azure.ai.formrecognizer.models.FormPage\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormPage\"></xref>."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.models.FormRecognizerOperationResult?alt=com.azure.ai.formrecognizer.models.FormRecognizerOperationResult&text=FormRecognizerOperationResult\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.models.FormPage?alt=com.azure.ai.formrecognizer.models.FormPage&text=FormPage\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl(java.lang.String,com.azure.ai.formrecognizer.models.RecognizeContentOptions,com.azure.core.util.Context)"
fullName: "com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContentFromUrl(String formUrl, RecognizeContentOptions recognizeContentOptions, Context context)"
name: "beginRecognizeContentFromUrl(String formUrl, RecognizeContentOptions recognizeContentOptions, Context context)"
nameWithType: "FormRecognizerClient.beginRecognizeContentFromUrl(String formUrl, RecognizeContentOptions recognizeContentOptions, Context context)"
summary: "Recognizes content/layout data using optical character recognition (OCR).\n\nThe service does not support cancellation of the long running operation and returns with an error message indicating absence of cancellation support.\n\nContent recognition supports auto language identification and multilanguage documents, so only provide a language code if you would like to force the documented to be processed as that specific language in the <xref uid=\"com.azure.ai.formrecognizer.models.RecognizeContentOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"options\"></xref>.\n\n**Code sample**\n\n```java\nString formPath = \"{file_source_url}\";\n formRecognizerClient.beginRecognizeContentFromUrl(formPath,\n new RecognizeContentOptions()\n .setPollInterval(Duration.ofSeconds(5)), Context.NONE)\n .getFinalResult()\n .forEach(formPage -> {\n System.out.printf(\"Page Angle: %s%n\", formPage.getTextAngle());\n System.out.printf(\"Page Dimension unit: %s%n\", formPage.getUnit());\n // Table information\n System.out.println(\"Recognized Tables: \");\n formPage.getTables()\n .stream()\n .flatMap(formTable -> formTable.getCells().stream())\n .forEach(recognizedTableCell -> System.out.printf(\"%s \", recognizedTableCell.getText()));\n });\n```"
parameters:
- description: "The source URL to the input form."
name: "formUrl"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The additional configurable <xref uid=\"com.azure.ai.formrecognizer.models.RecognizeContentOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"options\"></xref>\n that may be passed when recognizing content/layout on a form."
name: "recognizeContentOptions"
type: "<xref href=\"com.azure.ai.formrecognizer.models.RecognizeContentOptions?alt=com.azure.ai.formrecognizer.models.RecognizeContentOptions&text=RecognizeContentOptions\" data-throw-if-not-resolved=\"False\" />"
- description: "Additional context that is passed through the HTTP pipeline during the service call."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SyncPoller<FormRecognizerOperationResult,List<FormPage>> beginRecognizeContentFromUrl(String formUrl, RecognizeContentOptions recognizeContentOptions, Context context)"
returns:
description: "A <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> that polls the recognize layout operation until it has completed, has\n failed, or has been cancelled. The completed operation returns a list of <xref uid=\"com.azure.ai.formrecognizer.models.FormPage\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormPage\"></xref>."
type: "<xref href=\"com.azure.core.util.polling.SyncPoller?alt=com.azure.core.util.polling.SyncPoller&text=SyncPoller\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.models.FormRecognizerOperationResult?alt=com.azure.ai.formrecognizer.models.FormRecognizerOperationResult&text=FormRecognizerOperationResult\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.models.FormPage?alt=com.azure.ai.formrecognizer.models.FormPage&text=FormPage\" data-throw-if-not-resolved=\"False\" />>>"
type: "method"
metadata: {}
package: "com.azure.ai.formrecognizer"
artifact: com.azure:azure-ai-formrecognizer:3.1.10