CI Update
Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=379517&view=results
This commit is contained in:
VSC-Service-Account
Родитель
33a6c43f5f
Коммит
a0b9867ce1
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.FormRecognizerAsyncClient"
|
|||
fullName: "com.azure.ai.formrecognizer.FormRecognizerAsyncClient"
|
||||
name: "FormRecognizerAsyncClient"
|
||||
nameWithType: "FormRecognizerAsyncClient"
|
||||
summary: "This class provides an asynchronous client that contains all the operations that apply to Azure Form Recognizer."
|
||||
summary: "This class provides an asynchronous client to connect to the Form Recognizer Azure Cognitive Service."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -443,7 +443,7 @@ methods:
|
|||
description: "A <xref uid=\"com.azure.core.util.polling.PollerFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollerFlux\"></xref> that polls the recognize receipt 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.RecognizedForm\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RecognizedForm\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.util.polling.PollerFlux?alt=com.azure.core.util.polling.PollerFlux&text=PollerFlux\" 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\" />,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.RecognizedForm?alt=com.azure.ai.formrecognizer.models.RecognizedForm&text=RecognizedForm\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
type: "class"
|
||||
desc: "This class provides an asynchronous client that contains all the operations that apply to Azure Form Recognizer. Operations allowed by the client are recognizing receipt, business card, invoice and identity document data from input documents, extracting layout information, analyzing custom forms for predefined data.\n\n**Instantiating an asynchronous Form Recognizer Client**\n\n```java\nFormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildAsyncClient();\n```"
|
||||
desc: "This class provides an asynchronous client to connect to the Form Recognizer Azure Cognitive Service.\n\nThis client provides asynchronous methods to perform:\n\n1. Custom Form Analysis: Extraction and analysis of data from forms and documents specific to distinct business data and use cases. Use the custom trained model by passing its modelId into the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient.beginRecognizeCustomForms*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"beginRecognizeCustomForms\"></xref> method.\n2. Prebuilt Model Analysis: Analyze receipts, business cards, invoices and other documents with [supported prebuilt models][] Use the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient.beginRecognizeReceipts*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"beginRecognizeReceipts\"></xref> method to recognize receipt information.\n3. Layout Analysis: Extraction and analysis of text, selection marks, tables, and bounding box coordinates, from forms and documents. Use <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient.beginRecognizeContent*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"beginRecognizeContent\"></xref> method tpo perform layout analysis.\n4. Polling and Callbacks: It includes mechanisms for polling the service to check the status of an analysis operation or registering callbacks to receive notifications when the analysis is complete.\n\n**Note:** This client only supports <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerServiceVersion.V2_1\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerServiceVersion#V2_1\"></xref> and lower. Recommended to use a newer service version, <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\"></xref>.\n\n**Refer to the [Migration guide][] to use API versions 2022-08-31 and up.**\n\nService clients are the point of interaction for developers to use Azure Form Recognizer. <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerClient\"></xref> is the synchronous service client and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\"></xref> is the asynchronous service client. The examples shown in this document use a credential object named DefaultAzureCredential for authentication, which is appropriate for most scenarios, including local development and production environments. Additionally, we recommend using [managed identity][] for authentication in production environments. You can find more information on different ways of authenticating and their corresponding credential types in the [Azure Identity documentation\"][Azure Identity documentation].\n\n**Sample: Construct a FormRecognizerClient with DefaultAzureCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\"></xref>, using the \\`DefaultAzureCredentialBuilder\\` to configure it.\n\n```java\nFormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder()\n .endpoint(\"{endpoint}\")\n .credential(new DefaultAzureCredentialBuilder().build())\n .buildAsyncClient();\n```\n\nFurther, see the code sample below to use <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> for client creation.\n\n```java\nFormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildAsyncClient();\n```\n\n\n[supported prebuilt models]: https://aka.ms/form-recognizer-service-2.1.0\n[Migration guide]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md\n[managed identity]: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/\n[Azure Identity documentation]: https://learn.microsoft.com/java/api/overview/azure/identity-readme"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.FormRecognizerClient"
|
|||
fullName: "com.azure.ai.formrecognizer.FormRecognizerClient"
|
||||
name: "FormRecognizerClient"
|
||||
nameWithType: "FormRecognizerClient"
|
||||
summary: "This class provides a synchronous client that contains all the operations that apply to Azure Form Recognizer."
|
||||
summary: "This class provides an synchronous client to connect to the Form Recognizer Azure Cognitive Service."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -479,7 +479,7 @@ methods:
|
|||
description: "A <xref uid=\"com.azure.core.util.polling.SyncPoller\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SyncPoller\"></xref> to poll the progress of the recognize receipt operation until it has completed,\n has failed, or has been cancelled. The completed operation returns a list of <xref uid=\"com.azure.ai.formrecognizer.models.RecognizedForm\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RecognizedForm\"></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\" />,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.RecognizedForm?alt=com.azure.ai.formrecognizer.models.RecognizedForm&text=RecognizedForm\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
type: "class"
|
||||
desc: "This class provides a synchronous client that contains all the operations that apply to Azure Form Recognizer. Operations allowed by the client are recognizing receipt, business card, invoice and identity document data from input documents, recognizing layout information and analyzing custom forms for predefined data.\n\n**Instantiating a synchronous Form Recognizer Client**\n\n```java\nFormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildClient();\n```"
|
||||
desc: "This class provides an synchronous client to connect to the Form Recognizer Azure Cognitive Service.\n\nThis client provides synchronous methods to perform:\n\n1. Custom Form Analysis: Extraction and analysis of data from forms and documents specific to distinct business data and use cases. Use the custom trained model by passing its modelId into the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeCustomForms*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"beginRecognizeCustomForms\"></xref> method.\n2. Prebuilt Model Analysis: Analyze receipts, business cards, invoices and other documents with [supported prebuilt models][] Use the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeReceipts*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"beginRecognizeReceipts\"></xref> method to recognize receipt information.\n3. Layout Analysis: Extraction and analysis of text, selection marks, tables, and bounding box coordinates, from forms and documents. Use <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient.beginRecognizeContent(java.io.InputStream,long)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"beginRecognizeContent\"></xref> method tpo perform layout analysis.\n4. Polling and Callbacks: It includes mechanisms for polling the service to check the status of an analysis operation or registering callbacks to receive notifications when the analysis is complete.\n\n**Refer to the [Migration guide][] to use API versions 2022-08-31 and up.**\n\nService clients are the point of interaction for developers to use Azure Form Recognizer. <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerClient\"></xref> is the synchronous service client and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\"></xref> is the asynchronous service client. The examples shown in this document use a credential object named DefaultAzureCredential for authentication, which is appropriate for most scenarios, including local development and production environments. Additionally, we recommend using [managed identity][] for authentication in production environments. You can find more information on different ways of authenticating and their corresponding credential types in the [Azure Identity documentation\"][Azure Identity documentation].\n\n**Sample: Construct a FormRecognizerClient with DefaultAzureCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.FormRecognizerClient\"></xref>, using the \\`DefaultAzureCredentialBuilder\\` to configure it.\n\n```java\nFormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()\n .endpoint(\"{endpoint}\")\n .credential(new DefaultAzureCredentialBuilder().build())\n .buildClient();\n```\n\nFurther, see the code sample below to use <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> for client creation.\n\n```java\nFormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildClient();\n```\n\n\n[supported prebuilt models]: https://aka.ms/form-recognizer-service-2.1.0\n[Migration guide]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md\n[managed identity]: https://learn.microsoft.com/azure/active-directory/managed-identities-azure-resources/\n[Azure Identity documentation]: https://learn.microsoft.com/java/api/overview/azure/identity-readme"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ methods:
|
|||
syntax: "public FormRecognizerClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
||||
returns:
|
||||
description: "The updated FormRecognizerClientBuilder object."
|
||||
description: "The updated FormRecognizerClientBuilder object.\n <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>"
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.configuration(Configuration configuration)"
|
||||
|
|
@ -252,4 +252,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -88,4 +88,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder"
|
||||
name: "DocumentAnalysisClientBuilder"
|
||||
nameWithType: "DocumentAnalysisClientBuilder"
|
||||
summary: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisClients\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisAsyncClients\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> build<wbr>Client\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
|
||||
summary: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisAsyncClient\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> build<wbr>Client\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -88,7 +88,7 @@ methods:
|
|||
syntax: "public DocumentAnalysisClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
||||
returns:
|
||||
description: "The updated DocumentAnalysisClientBuilder object."
|
||||
description: "The updated DocumentAnalysisClientBuilder object.\n <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>"
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder&text=DocumentAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.configuration(Configuration configuration)"
|
||||
|
|
@ -243,7 +243,7 @@ methods:
|
|||
description: "The updated DocumentAnalysisClientBuilder object."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder&text=DocumentAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisClients\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisAsyncClients\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> buildClient\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe client needs the service endpoint of the Azure Document Analysis to access the resource service and the audience for the service region that you want to target. <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(AzureKeyCredential)\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"credential(TokenCredential)\"></xref> gives the builder access credential.\n\n**Instantiating an asynchronous Document Analysis Client**\n\n```java\nDocumentAnalysisAsyncClient documentAnalysisAsyncClient = new DocumentAnalysisClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildAsyncClient();\n```\n\n**Instantiating a synchronous Document Analysis Client**\n\n```java\nDocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildClient();\n```\n\nAnother way to construct the client is using a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> and set the service endpoint with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref>. Using a pipeline requires additional setup but allows for finer control on how the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisAsyncClient\"></xref> is built.\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .policies(/* add policies */)\n .build();\n\n DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .pipeline(pipeline)\n .buildClient();\n```"
|
||||
desc: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisAsyncClient\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> buildClient\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe client needs the service endpoint of the Azure Document Analysis to access the resource service and the audience for the service region that you want to target. <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(AzureKeyCredential)\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"credential(TokenCredential)\"></xref> gives the builder access credential.\n\n**Instantiating an asynchronous Document Analysis Client**\n\n```java\nDocumentAnalysisAsyncClient documentAnalysisAsyncClient = new DocumentAnalysisClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildAsyncClient();\n```\n\n**Instantiating a synchronous Document Analysis Client**\n\n```java\nDocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .buildClient();\n```\n\nAnother way to construct the client is using a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> and set the service endpoint with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref>. Using a pipeline requires additional setup but allows for finer control on how the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentAnalysisAsyncClient\"></xref> is built.\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .policies(/* add policies */)\n .build();\n\n DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .pipeline(pipeline)\n .buildClient();\n```"
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder&text=DocumentAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder&text=DocumentAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
|
|
@ -252,4 +252,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder&text=DocumentAnalysisClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -34,8 +34,14 @@ fields:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisServiceVersion.V2022_08_31"
|
||||
name: "V2022_08_31"
|
||||
nameWithType: "DocumentAnalysisServiceVersion.V2022_08_31"
|
||||
summary: "Service version `2022-08-31`."
|
||||
desc: "Service version `2022-08-31`."
|
||||
summary: "Service version `\"2022-08-31\"`"
|
||||
desc: "Service version `\"2022-08-31\"`"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisServiceVersion.V2023_07_31"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisServiceVersion.V2023_07_31"
|
||||
name: "V2023_07_31"
|
||||
nameWithType: "DocumentAnalysisServiceVersion.V2023_07_31"
|
||||
summary: "Service version `2023-07-31`."
|
||||
desc: "Service version `2023-07-31`."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisServiceVersion.getLatest()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisServiceVersion.getLatest()"
|
||||
|
|
@ -82,4 +88,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelA
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder"
|
||||
name: "DocumentModelAdministrationClientBuilder"
|
||||
nameWithType: "DocumentModelAdministrationClientBuilder"
|
||||
summary: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAdminClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentTrainingAsyncClient\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> build<wbr>Client\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
|
||||
summary: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationAsyncClient\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> build<wbr>Client\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -64,7 +64,7 @@ methods:
|
|||
syntax: "public DocumentModelAdministrationAsyncClient buildAsyncClient()"
|
||||
desc: "Creates a <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationAsyncClient\"></xref> based on options set in the builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
||||
returns:
|
||||
description: "A DocumentTrainingAsyncClient with the options set from the builder."
|
||||
description: "A DocumentModelAdministrationAsyncClient with the options set from the builder."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient&text=DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildClient()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildClient()"
|
||||
|
|
@ -74,7 +74,7 @@ methods:
|
|||
syntax: "public DocumentModelAdministrationClient buildClient()"
|
||||
desc: "Creates a <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationClient\"></xref> based on options set in the builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
|
||||
returns:
|
||||
description: "A FormRecognizerAdminClient with the options set from the builder."
|
||||
description: "A DocumentModelAdministrationClient with the options set from the builder."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient&text=DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
|
|
@ -88,7 +88,7 @@ methods:
|
|||
syntax: "public DocumentModelAdministrationClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
|
||||
returns:
|
||||
description: "The updated DocumentModelAdministrationClientBuilder object."
|
||||
description: "The updated DocumentModelAdministrationClientBuilder object.\n <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>"
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder&text=DocumentModelAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.configuration(Configuration configuration)"
|
||||
|
|
@ -243,7 +243,7 @@ methods:
|
|||
description: "The updated DocumentModelAdministrationClientBuilder object."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder&text=DocumentModelAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAdminClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentTrainingAsyncClient\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> buildClient\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe client needs the service endpoint of the Azure Form Recognizer to access the resource service. <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(AzureKeyCredential)\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"credential(TokenCredential)\"></xref> gives the builder access credential.\n\n**Instantiating an asynchronous Document Model Administration Client**\n\n```java\nDocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =\n new DocumentModelAdministrationClientBuilder().buildAsyncClient();\n```\n\n**Instantiating a synchronous Document Model Administration Client**\n\n```java\nDocumentModelAdministrationClient documentModelAdministrationClient =\n new DocumentModelAdministrationClientBuilder().buildClient();\n```\n\nAnother way to construct the client is using a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> and set the service endpoint with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref>. Using a pipeline requires additional setup but allows for finer control on how the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationAsyncClient\"></xref> is built.\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .policies(/* add policies */)\n .build();\n\n DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =\n new DocumentModelAdministrationClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .pipeline(pipeline)\n .buildAsyncClient();\n```"
|
||||
desc: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationAsyncClient\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> buildClient\\} and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe client needs the service endpoint of the Azure Form Recognizer to access the resource service. <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(AzureKeyCredential)\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"credential(TokenCredential)\"></xref> gives the builder access credential.\n\n**Sample: Instantiating an asynchronous Document Model Administration Client**\n\n```java\nDocumentModelAdministrationAsyncClient client = new DocumentModelAdministrationClientBuilder()\n .endpoint(\"{endpoint}\")\n .credential(new DefaultAzureCredentialBuilder().build())\n .buildAsyncClient();\n```\n\n**Sample: Instantiating a synchronous Document Model Administration Client**\n\n```java\nDocumentModelAdministrationClient client = new DocumentModelAdministrationClientBuilder()\n .endpoint(\"{endpoint}\")\n .credential(new DefaultAzureCredentialBuilder().build())\n .buildClient();\n```\n\nAnother way to construct the client is using a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> and set the service endpoint with <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref>. Using a pipeline requires additional setup but allows for finer control on how the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentModelAdministrationAsyncClient\"></xref> is built.\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .policies(/* add policies */)\n .build();\n\n DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =\n new DocumentModelAdministrationClientBuilder()\n .credential(new AzureKeyCredential(\"{key}\"))\n .endpoint(\"{endpoint}\")\n .pipeline(pipeline)\n .buildAsyncClient();\n```"
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder&text=DocumentModelAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder&text=DocumentModelAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
|
|
@ -252,4 +252,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder?alt=com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClientBuilder&text=DocumentModelAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,89 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource"
|
||||
name: "BlobContentSource"
|
||||
nameWithType: "BlobContentSource"
|
||||
summary: "Azure Blob Storage content."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource&text=ContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BlobContentSource**</br> extends <xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource&text=ContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.BlobContentSource(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.BlobContentSource(String containerUrl)"
|
||||
name: "BlobContentSource(String containerUrl)"
|
||||
nameWithType: "BlobContentSource.BlobContentSource(String containerUrl)"
|
||||
summary: "Creates an instance of Blob<wbr>Content<wbr>Source class."
|
||||
parameters:
|
||||
- description: "the containerUrl value to set."
|
||||
name: "containerUrl"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public BlobContentSource(String containerUrl)"
|
||||
desc: "Creates an instance of BlobContentSource class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.getContainerUrl()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.getContainerUrl()"
|
||||
name: "getContainerUrl()"
|
||||
nameWithType: "BlobContentSource.getContainerUrl()"
|
||||
summary: "Get the container<wbr>Url property: Azure Blob Storage container URL."
|
||||
syntax: "public String getContainerUrl()"
|
||||
desc: "Get the containerUrl property: Azure Blob Storage container URL."
|
||||
returns:
|
||||
description: "the containerUrl value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.getKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "BlobContentSource.getKind()"
|
||||
summary: "Get the source kind of the training data."
|
||||
overridden: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind()"
|
||||
syntax: "public ContentSourceKind getKind()"
|
||||
desc: "Get the source kind of the training data."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.getPrefix()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.getPrefix()"
|
||||
name: "getPrefix()"
|
||||
nameWithType: "BlobContentSource.getPrefix()"
|
||||
summary: "Get the prefix property: Blob name prefix."
|
||||
syntax: "public String getPrefix()"
|
||||
desc: "Get the prefix property: Blob name prefix."
|
||||
returns:
|
||||
description: "the prefix value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.setPrefix(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource.setPrefix(String prefix)"
|
||||
name: "setPrefix(String prefix)"
|
||||
nameWithType: "BlobContentSource.setPrefix(String prefix)"
|
||||
summary: "Set the prefix property: Blob name prefix."
|
||||
parameters:
|
||||
- description: "the prefix value to set."
|
||||
name: "prefix"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public BlobContentSource setPrefix(String prefix)"
|
||||
desc: "Set the prefix property: Blob name prefix."
|
||||
returns:
|
||||
description: "the BlobContentSource object itself."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource&text=BlobContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Azure Blob Storage content."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource"
|
||||
name: "BlobFileListContentSource"
|
||||
nameWithType: "BlobFileListContentSource"
|
||||
summary: "File list in Azure Blob Storage."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource&text=ContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BlobFileListContentSource**</br> extends <xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource&text=ContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.BlobFileListContentSource(java.lang.String,java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.BlobFileListContentSource(String containerUrl, String fileList)"
|
||||
name: "BlobFileListContentSource(String containerUrl, String fileList)"
|
||||
nameWithType: "BlobFileListContentSource.BlobFileListContentSource(String containerUrl, String fileList)"
|
||||
summary: "Creates an instance of Blob<wbr>File<wbr>List<wbr>Content<wbr>Source class."
|
||||
parameters:
|
||||
- description: "the containerUrl value to set."
|
||||
name: "containerUrl"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the fileList value to set."
|
||||
name: "fileList"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public BlobFileListContentSource(String containerUrl, String fileList)"
|
||||
desc: "Creates an instance of BlobFileListContentSource class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.getContainerUrl()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.getContainerUrl()"
|
||||
name: "getContainerUrl()"
|
||||
nameWithType: "BlobFileListContentSource.getContainerUrl()"
|
||||
summary: "Get the container<wbr>Url property: Azure Blob Storage container URL."
|
||||
syntax: "public String getContainerUrl()"
|
||||
desc: "Get the containerUrl property: Azure Blob Storage container URL."
|
||||
returns:
|
||||
description: "the containerUrl value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.getFileList()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.getFileList()"
|
||||
name: "getFileList()"
|
||||
nameWithType: "BlobFileListContentSource.getFileList()"
|
||||
summary: "Get the file<wbr>List property: Path to a JSONL file within the container specifying a subset of documents for training."
|
||||
syntax: "public String getFileList()"
|
||||
desc: "Get the fileList property: Path to a JSONL file within the container specifying a subset of documents for training."
|
||||
returns:
|
||||
description: "the fileList value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.getKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "BlobFileListContentSource.getKind()"
|
||||
summary: "Get the source kind of the training data."
|
||||
overridden: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind()"
|
||||
syntax: "public ContentSourceKind getKind()"
|
||||
desc: "Get the source kind of the training data."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "File list in Azure Blob Storage."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions"
|
||||
name: "BuildDocumentClassifierOptions"
|
||||
nameWithType: "BuildDocumentClassifierOptions"
|
||||
summary: "The configurable options to pass when building document classifier models."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **BuildDocumentClassifierOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.BuildDocumentClassifierOptions()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.BuildDocumentClassifierOptions()"
|
||||
name: "BuildDocumentClassifierOptions()"
|
||||
nameWithType: "BuildDocumentClassifierOptions.BuildDocumentClassifierOptions()"
|
||||
syntax: "public BuildDocumentClassifierOptions()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.getClassifierId()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.getClassifierId()"
|
||||
name: "getClassifierId()"
|
||||
nameWithType: "BuildDocumentClassifierOptions.getClassifierId()"
|
||||
summary: "Get the unique document classifier name."
|
||||
syntax: "public String getClassifierId()"
|
||||
desc: "Get the unique document classifier name."
|
||||
returns:
|
||||
description: "the classifierId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.getDescription()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.getDescription()"
|
||||
name: "getDescription()"
|
||||
nameWithType: "BuildDocumentClassifierOptions.getDescription()"
|
||||
summary: "Get the model description."
|
||||
syntax: "public String getDescription()"
|
||||
desc: "Get the model description."
|
||||
returns:
|
||||
description: "the model description value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.setClassifierId(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.setClassifierId(String classifierId)"
|
||||
name: "setClassifierId(String classifierId)"
|
||||
nameWithType: "BuildDocumentClassifierOptions.setClassifierId(String classifierId)"
|
||||
summary: "Set the unique document classifier name."
|
||||
parameters:
|
||||
- description: "the classifierId value to set."
|
||||
name: "classifierId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public BuildDocumentClassifierOptions setClassifierId(String classifierId)"
|
||||
desc: "Set the unique document classifier name."
|
||||
returns:
|
||||
description: "the BuildDocumentClassifierOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions&text=BuildDocumentClassifierOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.setDescription(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions.setDescription(String description)"
|
||||
name: "setDescription(String description)"
|
||||
nameWithType: "BuildDocumentClassifierOptions.setDescription(String description)"
|
||||
summary: "Set the model description."
|
||||
parameters:
|
||||
- description: "the model description value to set."
|
||||
name: "description"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public BuildDocumentClassifierOptions setDescription(String description)"
|
||||
desc: "Set the model description."
|
||||
returns:
|
||||
description: "the BuildDocumentClassifierOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions&text=BuildDocumentClassifierOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The configurable options to pass when building document classifier models."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDo
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentModelOptions"
|
||||
name: "BuildDocumentModelOptions"
|
||||
nameWithType: "BuildDocumentModelOptions"
|
||||
summary: "Options that may be passed to build document models."
|
||||
summary: "The configurable options to pass when building document models."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -101,7 +101,7 @@ methods:
|
|||
description: "the BuildDocumentModelOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentModelOptions?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentModelOptions&text=BuildDocumentModelOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Options that may be passed to build document models."
|
||||
desc: "The configurable options to pass when building document models."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,51 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails"
|
||||
name: "ClassifierDocumentTypeDetails"
|
||||
nameWithType: "ClassifierDocumentTypeDetails"
|
||||
summary: "Model representing details for classifier document types info."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **ClassifierDocumentTypeDetails**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails.ClassifierDocumentTypeDetails(com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails.ClassifierDocumentTypeDetails(ContentSource source)"
|
||||
name: "ClassifierDocumentTypeDetails(ContentSource source)"
|
||||
nameWithType: "ClassifierDocumentTypeDetails.ClassifierDocumentTypeDetails(ContentSource source)"
|
||||
summary: "Creates an instance of Classifier<wbr>Document<wbr>Type<wbr>Details class."
|
||||
parameters:
|
||||
- description: "the source of the training data."
|
||||
name: "source"
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource&text=ContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ClassifierDocumentTypeDetails(ContentSource source)"
|
||||
desc: "Creates an instance of ClassifierDocumentTypeDetails class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails.getContentSource()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails.getContentSource()"
|
||||
name: "getContentSource()"
|
||||
nameWithType: "ClassifierDocumentTypeDetails.getContentSource()"
|
||||
summary: "Get the source of the data."
|
||||
syntax: "public ContentSource getContentSource()"
|
||||
desc: "Get the source of the data. It can be a <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContentSource\"></xref> or a <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobFileListContentSource\"></xref>."
|
||||
returns:
|
||||
description: "the ContentSource value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource&text=ContentSource\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Model representing details for classifier document types info."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -104,4 +104,4 @@ type: "class"
|
|||
desc: "The configurable options to pass when creating a composed document model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource"
|
||||
name: "ContentSource"
|
||||
nameWithType: "ContentSource"
|
||||
summary: "Class representing the source of the data/content."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public abstract class **ContentSource**"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "ContentSource.getKind()"
|
||||
summary: "Get the source kind of the training data."
|
||||
syntax: "public ContentSourceKind getKind()"
|
||||
desc: "Get the source kind of the training data."
|
||||
returns:
|
||||
description: "the sourceKind value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Class representing the source of the data/content."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind"
|
||||
name: "ContentSourceKind"
|
||||
nameWithType: "ContentSourceKind"
|
||||
summary: "Type of content source."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **ContentSourceKind**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.ContentSourceKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.ContentSourceKind()"
|
||||
name: "ContentSourceKind()"
|
||||
nameWithType: "ContentSourceKind.ContentSourceKind()"
|
||||
syntax: "public ContentSourceKind()"
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.AZURE_BLOB"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.AZURE_BLOB"
|
||||
name: "AZURE_BLOB"
|
||||
nameWithType: "ContentSourceKind.AZURE_BLOB"
|
||||
summary: "Enum value azure<wbr>Blob."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ContentSourceKind AZURE_BLOB"
|
||||
desc: "Enum value azureBlob."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.AZURE_BLOB_FILE_LIST"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.AZURE_BLOB_FILE_LIST"
|
||||
name: "AZURE_BLOB_FILE_LIST"
|
||||
nameWithType: "ContentSourceKind.AZURE_BLOB_FILE_LIST"
|
||||
summary: "Enum value azure<wbr>Blob<wbr>File<wbr>List."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ContentSourceKind AZURE_BLOB_FILE_LIST"
|
||||
desc: "Enum value azureBlobFileList."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "ContentSourceKind.fromString(String name)"
|
||||
summary: "Creates or finds a Content<wbr>Source<wbr>Kind from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ContentSourceKind fromString(String name)"
|
||||
desc: "Creates or finds a ContentSourceKind from its string representation."
|
||||
returns:
|
||||
description: "the corresponding ContentSourceKind."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.values()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ContentSourceKind.values()"
|
||||
summary: "Gets known Content<wbr>Source<wbr>Kind values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<ContentSourceKind> values()"
|
||||
desc: "Gets known ContentSourceKind values."
|
||||
returns:
|
||||
description: "known ContentSourceKind values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind&text=ContentSourceKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Type of content source."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.CopyAut
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.CopyAuthorizationOptions"
|
||||
name: "CopyAuthorizationOptions"
|
||||
nameWithType: "CopyAuthorizationOptions"
|
||||
summary: "Options that may be passed when copying models into the target Form Recognizer resource."
|
||||
summary: "The configurable options to pass when copying models into the target Form Recognizer resource."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -101,7 +101,7 @@ methods:
|
|||
description: "the CopyAuthorizationOptions object itself."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.CopyAuthorizationOptions?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.CopyAuthorizationOptions&text=CopyAuthorizationOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Options that may be passed when copying models into the target Form Recognizer resource."
|
||||
desc: "The configurable options to pass when copying models into the target Form Recognizer resource."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails"
|
||||
name: "DocumentClassifierDetails"
|
||||
nameWithType: "DocumentClassifierDetails"
|
||||
summary: "Document classifier information model."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DocumentClassifierDetails**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.DocumentClassifierDetails()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.DocumentClassifierDetails()"
|
||||
name: "DocumentClassifierDetails()"
|
||||
nameWithType: "DocumentClassifierDetails.DocumentClassifierDetails()"
|
||||
summary: "Creates an instance of Document<wbr>Classifier<wbr>Details class."
|
||||
syntax: "public DocumentClassifierDetails()"
|
||||
desc: "Creates an instance of DocumentClassifierDetails class."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getClassifierId()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getClassifierId()"
|
||||
name: "getClassifierId()"
|
||||
nameWithType: "DocumentClassifierDetails.getClassifierId()"
|
||||
summary: "Get the classifier<wbr>Id property: Unique document classifier name."
|
||||
syntax: "public String getClassifierId()"
|
||||
desc: "Get the classifierId property: Unique document classifier name."
|
||||
returns:
|
||||
description: "the classifierId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getCreatedOn()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getCreatedOn()"
|
||||
name: "getCreatedOn()"
|
||||
nameWithType: "DocumentClassifierDetails.getCreatedOn()"
|
||||
summary: "Get the created<wbr>Date<wbr>Time property: Date and time (UTC) when the document classifier was created."
|
||||
syntax: "public OffsetDateTime getCreatedOn()"
|
||||
desc: "Get the createdDateTime property: Date and time (UTC) when the document classifier was created."
|
||||
returns:
|
||||
description: "the createdDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getDescription()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getDescription()"
|
||||
name: "getDescription()"
|
||||
nameWithType: "DocumentClassifierDetails.getDescription()"
|
||||
summary: "Get the description property: Document classifier description."
|
||||
syntax: "public String getDescription()"
|
||||
desc: "Get the description property: Document classifier description."
|
||||
returns:
|
||||
description: "the description value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getDocumentTypes()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getDocumentTypes()"
|
||||
name: "getDocumentTypes()"
|
||||
nameWithType: "DocumentClassifierDetails.getDocumentTypes()"
|
||||
summary: "Get list of document types to classify against along with their details."
|
||||
syntax: "public Map<String,ClassifierDocumentTypeDetails> getDocumentTypes()"
|
||||
desc: "Get list of document types to classify against along with their details."
|
||||
returns:
|
||||
description: "the docTypes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails&text=ClassifierDocumentTypeDetails\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getExpiresOn()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getExpiresOn()"
|
||||
name: "getExpiresOn()"
|
||||
nameWithType: "DocumentClassifierDetails.getExpiresOn()"
|
||||
summary: "Get the expiration<wbr>Date<wbr>Time property: Date and time (UTC) when the document classifier will expire."
|
||||
syntax: "public OffsetDateTime getExpiresOn()"
|
||||
desc: "Get the expirationDateTime property: Date and time (UTC) when the document classifier will expire."
|
||||
returns:
|
||||
description: "the expirationDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getServiceVersion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails.getServiceVersion()"
|
||||
name: "getServiceVersion()"
|
||||
nameWithType: "DocumentClassifierDetails.getServiceVersion()"
|
||||
summary: "Get the Service version used to create this document classifier."
|
||||
syntax: "public String getServiceVersion()"
|
||||
desc: "Get the Service version used to create this document classifier."
|
||||
returns:
|
||||
description: "the serviceVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Document classifier information model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -32,9 +32,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema.getDescription()"
|
||||
name: "getDescription()"
|
||||
nameWithType: "DocumentFieldSchema.getDescription()"
|
||||
summary: "Get the description property: Field description."
|
||||
summary: "Get the Field description."
|
||||
syntax: "public String getDescription()"
|
||||
desc: "Get the description property: Field description."
|
||||
desc: "Get the Field description."
|
||||
returns:
|
||||
description: "the description value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
|
|
@ -42,9 +42,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema.getExample()"
|
||||
name: "getExample()"
|
||||
nameWithType: "DocumentFieldSchema.getExample()"
|
||||
summary: "Get the example property: Example field content."
|
||||
summary: "Get the example field content."
|
||||
syntax: "public String getExample()"
|
||||
desc: "Get the example property: Example field content."
|
||||
desc: "Get the example field content."
|
||||
returns:
|
||||
description: "the example value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
|
|
@ -52,9 +52,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema.getItems()"
|
||||
name: "getItems()"
|
||||
nameWithType: "DocumentFieldSchema.getItems()"
|
||||
summary: "Get the items property: Field type schema of each array element."
|
||||
summary: "Get the Field type schema of each array element."
|
||||
syntax: "public DocumentFieldSchema getItems()"
|
||||
desc: "Get the items property: Field type schema of each array element."
|
||||
desc: "Get the Field type schema of each array element."
|
||||
returns:
|
||||
description: "the items value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema&text=DocumentFieldSchema\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -72,9 +72,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema.getType()"
|
||||
name: "getType()"
|
||||
nameWithType: "DocumentFieldSchema.getType()"
|
||||
summary: "Get the type property: Semantic data type of the field value."
|
||||
summary: "Get the Semantic data type of the field value."
|
||||
syntax: "public DocumentFieldType getType()"
|
||||
desc: "Get the type property: Semantic data type of the field value."
|
||||
desc: "Get the Semantic data type of the field value."
|
||||
returns:
|
||||
description: "the type value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType&text=DocumentFieldType\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -82,4 +82,4 @@ type: "class"
|
|||
desc: "Description of the field semantic schema using a JSON Schema style syntax."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Documen
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode"
|
||||
name: "DocumentModelBuildMode"
|
||||
nameWithType: "DocumentModelBuildMode"
|
||||
summary: "Defines values for Document<wbr>Model<wbr>Build<wbr>Mode."
|
||||
summary: "Class describing the custom document build mode values"
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -37,26 +37,26 @@ fields:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode.NEURAL"
|
||||
name: "NEURAL"
|
||||
nameWithType: "DocumentModelBuildMode.NEURAL"
|
||||
summary: "Static value neural for Document<wbr>Model<wbr>Build<wbr>Mode."
|
||||
summary: "Used for English documents with diverse visual templates."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode&text=DocumentModelBuildMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentModelBuildMode NEURAL"
|
||||
desc: "Static value neural for DocumentModelBuildMode. Used for English documents with diverse visual templates."
|
||||
desc: "Used for English documents with diverse visual templates."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode.TEMPLATE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode.TEMPLATE"
|
||||
name: "TEMPLATE"
|
||||
nameWithType: "DocumentModelBuildMode.TEMPLATE"
|
||||
summary: "Static value template for Document<wbr>Model<wbr>Build<wbr>Mode."
|
||||
summary: "Used for documents with fixed visual templates."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode&text=DocumentModelBuildMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentModelBuildMode TEMPLATE"
|
||||
desc: "Static value template for DocumentModelBuildMode. Used for documents with fixed visual templates."
|
||||
desc: "Used for documents with fixed visual templates."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode.fromString(String name)"
|
||||
|
|
@ -85,7 +85,7 @@ methods:
|
|||
description: "known DocumentModelBuildMode values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode&text=DocumentModelBuildMode\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Defines values for DocumentModelBuildMode."
|
||||
desc: "Class describing the custom document build mode values"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Documen
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildOperationDetails"
|
||||
name: "DocumentModelBuildOperationDetails"
|
||||
nameWithType: "DocumentModelBuildOperationDetails"
|
||||
summary: "Document model build operation details"
|
||||
summary: "Build document model operation details"
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -17,6 +17,7 @@ inheritedClassMethods:
|
|||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId&text=getOperationId\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted&text=getPercentCompleted\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation&text=getResourceLocation\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion&text=getServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus&text=getStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags&text=getTags\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
|
|
@ -44,14 +45,14 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildOperationDetails.getResult()"
|
||||
name: "getResult()"
|
||||
nameWithType: "DocumentModelBuildOperationDetails.getResult()"
|
||||
summary: "Get the result property: Operation result upon success."
|
||||
summary: "Get the operation result upon success."
|
||||
syntax: "public DocumentModelDetails getResult()"
|
||||
desc: "Get the result property: Operation result upon success."
|
||||
desc: "Get the operation result upon success."
|
||||
returns:
|
||||
description: "the result value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails&text=DocumentModelDetails\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Document model build operation details"
|
||||
desc: "Build document model operation details"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Documen
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelComposeOperationDetails"
|
||||
name: "DocumentModelComposeOperationDetails"
|
||||
nameWithType: "DocumentModelComposeOperationDetails"
|
||||
summary: "Get Operation response object."
|
||||
summary: "Compose document model operation details"
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -17,6 +17,7 @@ inheritedClassMethods:
|
|||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId&text=getOperationId\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted&text=getPercentCompleted\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation&text=getResourceLocation\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion&text=getServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus&text=getStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags&text=getTags\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
|
|
@ -44,14 +45,14 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelComposeOperationDetails.getResult()"
|
||||
name: "getResult()"
|
||||
nameWithType: "DocumentModelComposeOperationDetails.getResult()"
|
||||
summary: "Get the result property: Operation result upon success."
|
||||
summary: "Get the operation result upon success."
|
||||
syntax: "public DocumentModelDetails getResult()"
|
||||
desc: "Get the result property: Operation result upon success."
|
||||
desc: "Get the operation result upon success."
|
||||
returns:
|
||||
description: "the result value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails&text=DocumentModelDetails\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Get Operation response object."
|
||||
desc: "Compose document model operation details"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -113,4 +113,4 @@ type: "class"
|
|||
desc: "Authorization to copy a document model to the specified target resource and modelId."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Documen
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelCopyToOperationDetails"
|
||||
name: "DocumentModelCopyToOperationDetails"
|
||||
nameWithType: "DocumentModelCopyToOperationDetails"
|
||||
summary: "Get Operation response object."
|
||||
summary: "Copy document model operation details."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -17,6 +17,7 @@ inheritedClassMethods:
|
|||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getOperationId&text=getOperationId\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getPercentCompleted&text=getPercentCompleted\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getResourceLocation&text=getResourceLocation\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion&text=getServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus&text=getStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags()?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getTags&text=getTags\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
|
|
@ -51,7 +52,7 @@ methods:
|
|||
description: "the result value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails&text=DocumentModelDetails\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Get Operation response object."
|
||||
desc: "Copy document model operation details."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -58,6 +58,16 @@ methods:
|
|||
returns:
|
||||
description: "the docTypes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentTypeDetails?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentTypeDetails&text=DocumentTypeDetails\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getExpiresOn()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getExpiresOn()"
|
||||
name: "getExpiresOn()"
|
||||
nameWithType: "DocumentModelDetails.getExpiresOn()"
|
||||
summary: "Get the Date and time (UTC) when the analyze operation was submitted."
|
||||
syntax: "public OffsetDateTime getExpiresOn()"
|
||||
desc: "Get the Date and time (UTC) when the analyze operation was submitted."
|
||||
returns:
|
||||
description: "the expiresOn value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getModelId()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getModelId()"
|
||||
name: "getModelId()"
|
||||
|
|
@ -68,6 +78,16 @@ methods:
|
|||
returns:
|
||||
description: "the modelId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getServiceVersion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getServiceVersion()"
|
||||
name: "getServiceVersion()"
|
||||
nameWithType: "DocumentModelDetails.getServiceVersion()"
|
||||
summary: "Get the Service version used to create this document classifier."
|
||||
syntax: "public String getServiceVersion()"
|
||||
desc: "Get the Service version used to create this document classifier."
|
||||
returns:
|
||||
description: "the serviceVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getTags()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelDetails.getTags()"
|
||||
name: "getTags()"
|
||||
|
|
@ -82,4 +102,4 @@ type: "class"
|
|||
desc: "Information about the document model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Documen
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary"
|
||||
name: "DocumentModelSummary"
|
||||
nameWithType: "DocumentModelSummary"
|
||||
summary: "Model summary for the built and prebuilt models."
|
||||
summary: "Summary information for the built and prebuilt models."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -48,6 +48,16 @@ methods:
|
|||
returns:
|
||||
description: "the description value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getExpiresOn()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getExpiresOn()"
|
||||
name: "getExpiresOn()"
|
||||
nameWithType: "DocumentModelSummary.getExpiresOn()"
|
||||
summary: "Get the Date and time (UTC) when the document model will expire."
|
||||
syntax: "public OffsetDateTime getExpiresOn()"
|
||||
desc: "Get the Date and time (UTC) when the document model will expire."
|
||||
returns:
|
||||
description: "the expiresOn value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getModelId()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getModelId()"
|
||||
name: "getModelId()"
|
||||
|
|
@ -58,6 +68,16 @@ methods:
|
|||
returns:
|
||||
description: "the modelId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getServiceVersion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getServiceVersion()"
|
||||
name: "getServiceVersion()"
|
||||
nameWithType: "DocumentModelSummary.getServiceVersion()"
|
||||
summary: "Get the Service version used to create this document classifier."
|
||||
syntax: "public String getServiceVersion()"
|
||||
desc: "Get the Service version used to create this document classifier."
|
||||
returns:
|
||||
description: "the serviceVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getTags()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelSummary.getTags()"
|
||||
name: "getTags()"
|
||||
|
|
@ -69,7 +89,7 @@ methods:
|
|||
description: "the tags value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
type: "class"
|
||||
desc: "Model summary for the built and prebuilt models."
|
||||
desc: "Summary information for the built and prebuilt models."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -72,4 +72,4 @@ type: "class"
|
|||
desc: "The DocumentTypeDetails model representing detailed information about the document type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -98,6 +98,16 @@ methods:
|
|||
returns:
|
||||
description: "the resourceLocation value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getServiceVersion()"
|
||||
name: "getServiceVersion()"
|
||||
nameWithType: "OperationDetails.getServiceVersion()"
|
||||
summary: "Get the Service version used to create this document classifier."
|
||||
syntax: "public String getServiceVersion()"
|
||||
desc: "Get the Service version used to create this document classifier."
|
||||
returns:
|
||||
description: "the serviceVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationDetails.getStatus()"
|
||||
name: "getStatus()"
|
||||
|
|
@ -122,4 +132,4 @@ type: "class"
|
|||
desc: "The OperationDetails model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Operati
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationKind"
|
||||
name: "OperationKind"
|
||||
nameWithType: "OperationKind"
|
||||
summary: "Defines values for Operation<wbr>Kind."
|
||||
summary: "Known values for type of operation."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -97,7 +97,7 @@ methods:
|
|||
description: "known OperationKind values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationKind?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationKind&text=OperationKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Defines values for OperationKind."
|
||||
desc: "Known values for type of operation."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Operati
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationStatus"
|
||||
name: "OperationStatus"
|
||||
nameWithType: "OperationStatus"
|
||||
summary: "Defines values for Operation<wbr>Status."
|
||||
summary: "Known values for operation status."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -121,7 +121,7 @@ methods:
|
|||
description: "known OperationStatus values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationStatus?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationStatus&text=OperationStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Defines values for OperationStatus."
|
||||
desc: "Known values for operation status."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -88,6 +88,16 @@ methods:
|
|||
returns:
|
||||
description: "the resourceLocation value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationSummary.getServiceVersion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationSummary.getServiceVersion()"
|
||||
name: "getServiceVersion()"
|
||||
nameWithType: "OperationSummary.getServiceVersion()"
|
||||
summary: "Get the Service version used to create this document classifier."
|
||||
syntax: "public String getServiceVersion()"
|
||||
desc: "Get the Service version used to create this document classifier."
|
||||
returns:
|
||||
description: "the serviceVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationSummary.getStatus()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationSummary.getStatus()"
|
||||
name: "getStatus()"
|
||||
|
|
@ -112,4 +122,4 @@ type: "class"
|
|||
desc: "OperationSummary."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,65 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails"
|
||||
name: "QuotaDetails"
|
||||
nameWithType: "QuotaDetails"
|
||||
summary: "Quota used, limit, and next reset date/time."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **QuotaDetails**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.QuotaDetails()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.QuotaDetails()"
|
||||
name: "QuotaDetails()"
|
||||
nameWithType: "QuotaDetails.QuotaDetails()"
|
||||
syntax: "public QuotaDetails()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.getQuota()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.getQuota()"
|
||||
name: "getQuota()"
|
||||
nameWithType: "QuotaDetails.getQuota()"
|
||||
summary: "Get the quota property: Resource quota limit."
|
||||
syntax: "public int getQuota()"
|
||||
desc: "Get the quota property: Resource quota limit."
|
||||
returns:
|
||||
description: "the quota value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.getQuotaResetDateTime()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.getQuotaResetDateTime()"
|
||||
name: "getQuotaResetDateTime()"
|
||||
nameWithType: "QuotaDetails.getQuotaResetDateTime()"
|
||||
summary: "Get the quota<wbr>Reset<wbr>Date<wbr>Time property: Date/time when the resource quota usage will be reset."
|
||||
syntax: "public OffsetDateTime getQuotaResetDateTime()"
|
||||
desc: "Get the quotaResetDateTime property: Date/time when the resource quota usage will be reset."
|
||||
returns:
|
||||
description: "the quotaResetDateTime value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.getUsed()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails.getUsed()"
|
||||
name: "getUsed()"
|
||||
nameWithType: "QuotaDetails.getUsed()"
|
||||
summary: "Get the used property: Amount of the resource quota used."
|
||||
syntax: "public int getUsed()"
|
||||
desc: "Get the used property: Amount of the resource quota used."
|
||||
returns:
|
||||
description: "the used value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Quota used, limit, and next reset date/time."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.Resourc
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ResourceDetails"
|
||||
name: "ResourceDetails"
|
||||
nameWithType: "ResourceDetails"
|
||||
summary: "The Resource<wbr>Details model."
|
||||
summary: "The Resource<wbr>Details model representing general information regarding the current resource."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -48,8 +48,18 @@ methods:
|
|||
returns:
|
||||
description: "the limit value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ResourceDetails.getNeuralDocumentModelQuota()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models.ResourceDetails.getNeuralDocumentModelQuota()"
|
||||
name: "getNeuralDocumentModelQuota()"
|
||||
nameWithType: "ResourceDetails.getNeuralDocumentModelQuota()"
|
||||
summary: "Get the custom<wbr>Neural<wbr>Document<wbr>Model<wbr>Builds property: Quota used, limit, and next reset date/time."
|
||||
syntax: "public QuotaDetails getNeuralDocumentModelQuota()"
|
||||
desc: "Get the customNeuralDocumentModelBuilds property: Quota used, limit, and next reset date/time."
|
||||
returns:
|
||||
description: "the customNeuralDocumentModelBuilds value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails?alt=com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails&text=QuotaDetails\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "The ResourceDetails model."
|
||||
desc: "The ResourceDetails model representing general information regarding the current resource."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -2,11 +2,18 @@
|
|||
uid: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
name: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
summary: "Package containing model classes to perform operations <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\"></xref> and\n <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\"></xref>."
|
||||
summary: "Package containing model classes to perform operations using <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\"></xref> and\n <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\"></xref>."
|
||||
classes:
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobContentSource"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.BlobFileListContentSource"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentClassifierOptions"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.BuildDocumentModelOptions"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.ClassifierDocumentTypeDetails"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.ComposeDocumentModelOptions"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSource"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.ContentSourceKind"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.CopyAuthorizationOptions"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentClassifierDetails"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildMode"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentModelBuildOperationDetails"
|
||||
|
|
@ -20,8 +27,9 @@ classes:
|
|||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationKind"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationStatus"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.OperationSummary"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.QuotaDetails"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.administration.models.ResourceDetails"
|
||||
desc: "Package containing model classes to perform operations <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\"></xref> and\n <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\"></xref>."
|
||||
desc: "Package containing model classes to perform operations using <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationAsyncClient\"></xref> and\n <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.administration.DocumentModelAdministrationClient\"></xref>."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.administration.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -38,6 +38,16 @@ methods:
|
|||
returns:
|
||||
description: "the city value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getCityDistrict()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getCityDistrict()"
|
||||
name: "getCityDistrict()"
|
||||
nameWithType: "AddressValue.getCityDistrict()"
|
||||
summary: "Get the city<wbr>District property: Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London."
|
||||
syntax: "public String getCityDistrict()"
|
||||
desc: "Get the cityDistrict property: Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London."
|
||||
returns:
|
||||
description: "the cityDistrict value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getCountryRegion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getCountryRegion()"
|
||||
name: "getCountryRegion()"
|
||||
|
|
@ -48,6 +58,16 @@ methods:
|
|||
returns:
|
||||
description: "the countryRegion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getHouse()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getHouse()"
|
||||
name: "getHouse()"
|
||||
nameWithType: "AddressValue.getHouse()"
|
||||
summary: "Get the house property: Build name, such as World Trade Center."
|
||||
syntax: "public String getHouse()"
|
||||
desc: "Get the house property: Build name, such as World Trade Center."
|
||||
returns:
|
||||
description: "the house value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getHouseNumber()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getHouseNumber()"
|
||||
name: "getHouseNumber()"
|
||||
|
|
@ -58,6 +78,16 @@ methods:
|
|||
returns:
|
||||
description: "the houseNumber value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getLevel()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getLevel()"
|
||||
name: "getLevel()"
|
||||
nameWithType: "AddressValue.getLevel()"
|
||||
summary: "Get the level property: Floor number, such as 3F."
|
||||
syntax: "public String getLevel()"
|
||||
desc: "Get the level property: Floor number, such as 3F."
|
||||
returns:
|
||||
description: "the level value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getPoBox()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getPoBox()"
|
||||
name: "getPoBox()"
|
||||
|
|
@ -98,6 +128,16 @@ methods:
|
|||
returns:
|
||||
description: "the state value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getStateDistrict()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getStateDistrict()"
|
||||
name: "getStateDistrict()"
|
||||
nameWithType: "AddressValue.getStateDistrict()"
|
||||
summary: "Get the state<wbr>District property: Second-level administrative division used in certain locales."
|
||||
syntax: "public String getStateDistrict()"
|
||||
desc: "Get the stateDistrict property: Second-level administrative division used in certain locales."
|
||||
returns:
|
||||
description: "the stateDistrict value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getStreetAddress()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getStreetAddress()"
|
||||
name: "getStreetAddress()"
|
||||
|
|
@ -108,8 +148,28 @@ methods:
|
|||
returns:
|
||||
description: "the streetAddress value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getSuburb()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getSuburb()"
|
||||
name: "getSuburb()"
|
||||
nameWithType: "AddressValue.getSuburb()"
|
||||
summary: "Get the suburb property: Unofficial neighborhood name, like Chinatown."
|
||||
syntax: "public String getSuburb()"
|
||||
desc: "Get the suburb property: Unofficial neighborhood name, like Chinatown."
|
||||
returns:
|
||||
description: "the suburb value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getUnit()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue.getUnit()"
|
||||
name: "getUnit()"
|
||||
nameWithType: "AddressValue.getUnit()"
|
||||
summary: "Get the unit property: Apartment or office number."
|
||||
syntax: "public String getUnit()"
|
||||
desc: "Get the unit property: Apartment or office number."
|
||||
returns:
|
||||
description: "the unit value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Address field value."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions"
|
||||
name: "AnalyzeDocumentOptions"
|
||||
nameWithType: "AnalyzeDocumentOptions"
|
||||
summary: "Options that may be passed when using analyze document API on Document Analysis client."
|
||||
summary: "The configurable options to be passed when using analyze document API on Document Analysis client."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -28,6 +28,16 @@ constructors:
|
|||
nameWithType: "AnalyzeDocumentOptions.AnalyzeDocumentOptions()"
|
||||
syntax: "public AnalyzeDocumentOptions()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.getDocumentAnalysisFeatures()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.getDocumentAnalysisFeatures()"
|
||||
name: "getDocumentAnalysisFeatures()"
|
||||
nameWithType: "AnalyzeDocumentOptions.getDocumentAnalysisFeatures()"
|
||||
summary: "Get the list of optional analysis features."
|
||||
syntax: "public List<DocumentAnalysisFeature> getDocumentAnalysisFeatures()"
|
||||
desc: "Get the list of optional analysis features."
|
||||
returns:
|
||||
description: "List of optional analysis features."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.getLocale()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.getLocale()"
|
||||
name: "getLocale()"
|
||||
|
|
@ -42,12 +52,40 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.getPages()"
|
||||
name: "getPages()"
|
||||
nameWithType: "AnalyzeDocumentOptions.getPages()"
|
||||
summary: "Get the custom page numbers for multi-page documents(PDF/TIFF)."
|
||||
summary: "Get the custom page numbers for multipage documents(PDF/TIFF)."
|
||||
syntax: "public List<String> getPages()"
|
||||
desc: "Get the custom page numbers for multi-page documents(PDF/TIFF). Input the number of the pages you want to get the recognized result for.\n\nFor a range of pages, use a hyphen, ex - \\[\"1-3\"\\]. Separate each page or a page range with a comma, ex - \\[\"1-3\", 4\\]."
|
||||
desc: "Get the custom page numbers for multipage documents(PDF/TIFF). Input the number of the pages you want to get the recognized result for.\n\nFor a range of pages, use a hyphen, ex - \\[\"1-3\"\\]. Separate each page or a page range with a comma, ex - \\[\"1-3\", 4\\]."
|
||||
returns:
|
||||
description: "the list of custom page numbers for a multi page document."
|
||||
description: "the list of custom page numbers for a multipage document."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setDocumentAnalysisFeatures(com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature...)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)"
|
||||
name: "setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)"
|
||||
nameWithType: "AnalyzeDocumentOptions.setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)"
|
||||
summary: "Set optional analysis features."
|
||||
parameters:
|
||||
- description: "List of optional analysis features."
|
||||
name: "documentAnalysisFeatures"
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
syntax: "public AnalyzeDocumentOptions setDocumentAnalysisFeatures(DocumentAnalysisFeature[] documentAnalysisFeatures)"
|
||||
desc: "Set optional analysis features."
|
||||
returns:
|
||||
description: "the updated <code>AnalyzeDocumentOptions</code> value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions?alt=com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions&text=AnalyzeDocumentOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setDocumentAnalysisFeatures(java.util.List<com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature>)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures)"
|
||||
name: "setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures)"
|
||||
nameWithType: "AnalyzeDocumentOptions.setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures)"
|
||||
summary: "Set the list of optional analysis features."
|
||||
parameters:
|
||||
- description: "List of optional analysis features."
|
||||
name: "documentAnalysisFeatures"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public AnalyzeDocumentOptions setDocumentAnalysisFeatures(List<DocumentAnalysisFeature> documentAnalysisFeatures)"
|
||||
desc: "Set the list of optional analysis features."
|
||||
returns:
|
||||
description: "the updated <code>AnalyzeDocumentOptions</code> value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions?alt=com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions&text=AnalyzeDocumentOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setLocale(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setLocale(String locale)"
|
||||
name: "setLocale(String locale)"
|
||||
|
|
@ -60,24 +98,24 @@ methods:
|
|||
syntax: "public AnalyzeDocumentOptions setLocale(String locale)"
|
||||
desc: "Set the locale value. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US."
|
||||
returns:
|
||||
description: "the locale value."
|
||||
description: "the updated <code>AnalyzeDocumentOptions</code> value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions?alt=com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions&text=AnalyzeDocumentOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setPages(java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions.setPages(List<String> pages)"
|
||||
name: "setPages(List<String> pages)"
|
||||
nameWithType: "AnalyzeDocumentOptions.setPages(List<String> pages)"
|
||||
summary: "Set the custom page numbers for multi-page documents(PDF/TIFF)."
|
||||
summary: "Set the custom page numbers for multipage documents(PDF/TIFF)."
|
||||
parameters:
|
||||
- description: "the custom page numbers value to set."
|
||||
name: "pages"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public AnalyzeDocumentOptions setPages(List<String> pages)"
|
||||
desc: "Set the custom page numbers for multi-page documents(PDF/TIFF). Input the number of the pages you want to get the recognized result for.\n\nFor a range of pages, use a hyphen, ex - \\[\"1-3\"\\]. Separate each page or a page range with a comma, ex - \\[\"1-3\", 4\\]."
|
||||
desc: "Set the custom page numbers for multipage documents(PDF/TIFF). Input the number of the pages you want to get the recognized result for.\n\nFor a range of pages, use a hyphen, ex - \\[\"1-3\"\\]. Separate each page or a page range with a comma, ex - \\[\"1-3\", 4\\]."
|
||||
returns:
|
||||
description: "the updated <code>RecognizeContentOptions</code> value."
|
||||
description: "the updated <code>AnalyzeDocumentOptions</code> value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions?alt=com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions&text=AnalyzeDocumentOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Options that may be passed when using analyze document API on Document Analysis client."
|
||||
desc: "The configurable options to be passed when using analyze document API on Document Analysis client."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeResult"
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeResult"
|
||||
name: "AnalyzeResult"
|
||||
nameWithType: "AnalyzeResult"
|
||||
summary: "Document analysis result."
|
||||
summary: "Model representing the document analysis result."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -98,6 +98,16 @@ methods:
|
|||
returns:
|
||||
description: "the paragraphs value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentParagraph?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentParagraph&text=DocumentParagraph\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeResult.getServiceVersion()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeResult.getServiceVersion()"
|
||||
name: "getServiceVersion()"
|
||||
nameWithType: "AnalyzeResult.getServiceVersion()"
|
||||
summary: "Get the Service version used to create this document classifier."
|
||||
syntax: "public String getServiceVersion()"
|
||||
desc: "Get the Service version used to create this document classifier."
|
||||
returns:
|
||||
description: "the serviceVersion value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeResult.getStyles()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeResult.getStyles()"
|
||||
name: "getStyles()"
|
||||
|
|
@ -119,7 +129,7 @@ methods:
|
|||
description: "the tables value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentTable?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentTable&text=DocumentTable\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Document analysis result."
|
||||
desc: "Model representing the document analysis result."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzedDocument"
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzedDocument"
|
||||
name: "AnalyzedDocument"
|
||||
nameWithType: "AnalyzedDocument"
|
||||
summary: "An object describing the location and semantic content of a document."
|
||||
summary: "Model class describing the location and semantic content of a document."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -79,7 +79,7 @@ methods:
|
|||
description: "the spans value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan&text=DocumentSpan\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "An object describing the location and semantic content of a document."
|
||||
desc: "Model class describing the location and semantic content of a document."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.models.BoundingRegion"
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.BoundingRegion"
|
||||
name: "BoundingRegion"
|
||||
nameWithType: "BoundingRegion"
|
||||
summary: "Bounding polygon on a specific page of the input."
|
||||
summary: "Model representing the bounding polygon on a specific page of the input."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
|
|
@ -49,7 +49,7 @@ methods:
|
|||
description: "the pageNumber value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Bounding polygon on a specific page of the input."
|
||||
desc: "Model representing the bounding polygon on a specific page of the input."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -38,6 +38,16 @@ methods:
|
|||
returns:
|
||||
description: "the amount value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue.getCode()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue.getCode()"
|
||||
name: "getCode()"
|
||||
nameWithType: "CurrencyValue.getCode()"
|
||||
summary: "Get the resolved currency code (ISO 4217), if any."
|
||||
syntax: "public String getCode()"
|
||||
desc: "Get the resolved currency code (ISO 4217), if any."
|
||||
returns:
|
||||
description: "the code value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue.getSymbol()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue.getSymbol()"
|
||||
name: "getSymbol()"
|
||||
|
|
@ -52,4 +62,4 @@ type: "class"
|
|||
desc: "Currency field value."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -100,4 +100,4 @@ type: "class"
|
|||
desc: "Defines values for DocumentAnalysisAudience."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,145 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature"
|
||||
name: "DocumentAnalysisFeature"
|
||||
nameWithType: "DocumentAnalysisFeature"
|
||||
summary: "Defines values for Document<wbr>Analysis<wbr>Feature."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DocumentAnalysisFeature**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.DocumentAnalysisFeature()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.DocumentAnalysisFeature()"
|
||||
name: "DocumentAnalysisFeature()"
|
||||
nameWithType: "DocumentAnalysisFeature.DocumentAnalysisFeature()"
|
||||
summary: "Creates a new instance of Document<wbr>Analysis<wbr>Feature value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public DocumentAnalysisFeature()"
|
||||
desc: "Creates a new instance of DocumentAnalysisFeature value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.BARCODES"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.BARCODES"
|
||||
name: "BARCODES"
|
||||
nameWithType: "DocumentAnalysisFeature.BARCODES"
|
||||
summary: "Static value barcodes for Document<wbr>Analysis<wbr>Feature."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentAnalysisFeature BARCODES"
|
||||
desc: "Static value barcodes for DocumentAnalysisFeature."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.FORMULAS"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.FORMULAS"
|
||||
name: "FORMULAS"
|
||||
nameWithType: "DocumentAnalysisFeature.FORMULAS"
|
||||
summary: "Static value formulas for Document<wbr>Analysis<wbr>Feature."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentAnalysisFeature FORMULAS"
|
||||
desc: "Static value formulas for DocumentAnalysisFeature."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.KEY_VALUE_PAIRS"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.KEY_VALUE_PAIRS"
|
||||
name: "KEY_VALUE_PAIRS"
|
||||
nameWithType: "DocumentAnalysisFeature.KEY_VALUE_PAIRS"
|
||||
summary: "Static value key<wbr>Value<wbr>Pairs for Document<wbr>Analysis<wbr>Feature."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentAnalysisFeature KEY_VALUE_PAIRS"
|
||||
desc: "Static value keyValuePairs for DocumentAnalysisFeature."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.LANGUAGES"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.LANGUAGES"
|
||||
name: "LANGUAGES"
|
||||
nameWithType: "DocumentAnalysisFeature.LANGUAGES"
|
||||
summary: "Static value languages for Document<wbr>Analysis<wbr>Feature."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentAnalysisFeature LANGUAGES"
|
||||
desc: "Static value languages for DocumentAnalysisFeature."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.OCR_HIGH_RESOLUTION"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.OCR_HIGH_RESOLUTION"
|
||||
name: "OCR_HIGH_RESOLUTION"
|
||||
nameWithType: "DocumentAnalysisFeature.OCR_HIGH_RESOLUTION"
|
||||
summary: "Static value ocr<wbr>High<wbr>Resolution for Document<wbr>Analysis<wbr>Feature."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentAnalysisFeature OCR_HIGH_RESOLUTION"
|
||||
desc: "Static value ocrHighResolution for DocumentAnalysisFeature."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.STYLE_FONT"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.STYLE_FONT"
|
||||
name: "STYLE_FONT"
|
||||
nameWithType: "DocumentAnalysisFeature.STYLE_FONT"
|
||||
summary: "Static value style<wbr>Font for Document<wbr>Analysis<wbr>Feature."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentAnalysisFeature STYLE_FONT"
|
||||
desc: "Static value styleFont for DocumentAnalysisFeature."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "DocumentAnalysisFeature.fromString(String name)"
|
||||
summary: "Creates or finds a Document<wbr>Analysis<wbr>Feature from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static DocumentAnalysisFeature fromString(String name)"
|
||||
desc: "Creates or finds a DocumentAnalysisFeature from its string representation."
|
||||
returns:
|
||||
description: "the corresponding DocumentAnalysisFeature."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.values()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature.values()"
|
||||
name: "values()"
|
||||
nameWithType: "DocumentAnalysisFeature.values()"
|
||||
summary: "Gets known Document<wbr>Analysis<wbr>Feature values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<DocumentAnalysisFeature> values()"
|
||||
desc: "Gets known DocumentAnalysisFeature values."
|
||||
returns:
|
||||
description: "known DocumentAnalysisFeature values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature&text=DocumentAnalysisFeature\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Defines values for DocumentAnalysisFeature."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode"
|
||||
name: "DocumentBarcode"
|
||||
nameWithType: "DocumentBarcode"
|
||||
summary: "Model representing a barcode document field."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DocumentBarcode**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.DocumentBarcode()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.DocumentBarcode()"
|
||||
name: "DocumentBarcode()"
|
||||
nameWithType: "DocumentBarcode.DocumentBarcode()"
|
||||
syntax: "public DocumentBarcode()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getBoundingPolygon()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getBoundingPolygon()"
|
||||
name: "getBoundingPolygon()"
|
||||
nameWithType: "DocumentBarcode.getBoundingPolygon()"
|
||||
summary: "Get the polygon property: Bounding polygon of the barcode."
|
||||
syntax: "public List<Point> getBoundingPolygon()"
|
||||
desc: "Get the polygon property: Bounding polygon of the barcode."
|
||||
returns:
|
||||
description: "the polygon value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.Point?alt=com.azure.ai.formrecognizer.documentanalysis.models.Point&text=Point\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getConfidence()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DocumentBarcode.getConfidence()"
|
||||
summary: "Get the confidence property: Confidence of correctly extracting the barcode."
|
||||
syntax: "public float getConfidence()"
|
||||
desc: "Get the confidence property: Confidence of correctly extracting the barcode."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "DocumentBarcode.getKind()"
|
||||
summary: "Get the kind property: Barcode kind."
|
||||
syntax: "public DocumentBarcodeKind getKind()"
|
||||
desc: "Get the kind property: Barcode kind."
|
||||
returns:
|
||||
description: "the kind value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getSpan()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getSpan()"
|
||||
name: "getSpan()"
|
||||
nameWithType: "DocumentBarcode.getSpan()"
|
||||
summary: "Get the span property: Location of the barcode in the reading order concatenated content."
|
||||
syntax: "public DocumentSpan getSpan()"
|
||||
desc: "Get the span property: Location of the barcode in the reading order concatenated content."
|
||||
returns:
|
||||
description: "the span value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan&text=DocumentSpan\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getValue()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "DocumentBarcode.getValue()"
|
||||
summary: "Get the value property: Barcode value."
|
||||
syntax: "public String getValue()"
|
||||
desc: "Get the value property: Barcode value."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Model representing a barcode document field."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,277 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind"
|
||||
name: "DocumentBarcodeKind"
|
||||
nameWithType: "DocumentBarcodeKind"
|
||||
summary: "Barcode kind."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DocumentBarcodeKind**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DocumentBarcodeKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DocumentBarcodeKind()"
|
||||
name: "DocumentBarcodeKind()"
|
||||
nameWithType: "DocumentBarcodeKind.DocumentBarcodeKind()"
|
||||
summary: "Creates a new instance of Document<wbr>Barcode<wbr>Kind value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public DocumentBarcodeKind()"
|
||||
desc: "Creates a new instance of DocumentBarcodeKind value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.AZTEC"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.AZTEC"
|
||||
name: "AZTEC"
|
||||
nameWithType: "DocumentBarcodeKind.AZTEC"
|
||||
summary: "Static value Aztec for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind AZTEC"
|
||||
desc: "Static value Aztec for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODABAR"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODABAR"
|
||||
name: "CODABAR"
|
||||
nameWithType: "DocumentBarcodeKind.CODABAR"
|
||||
summary: "Static value Codabar for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind CODABAR"
|
||||
desc: "Static value Codabar for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODE_128"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODE_128"
|
||||
name: "CODE_128"
|
||||
nameWithType: "DocumentBarcodeKind.CODE_128"
|
||||
summary: "Static value Code128 for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind CODE_128"
|
||||
desc: "Static value Code128 for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODE_39"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODE_39"
|
||||
name: "CODE_39"
|
||||
nameWithType: "DocumentBarcodeKind.CODE_39"
|
||||
summary: "Static value Code39 for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind CODE_39"
|
||||
desc: "Static value Code39 for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODE_93"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.CODE_93"
|
||||
name: "CODE_93"
|
||||
nameWithType: "DocumentBarcodeKind.CODE_93"
|
||||
summary: "Static value Code93 for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind CODE_93"
|
||||
desc: "Static value Code93 for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DATA_BAR"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DATA_BAR"
|
||||
name: "DATA_BAR"
|
||||
nameWithType: "DocumentBarcodeKind.DATA_BAR"
|
||||
summary: "Static value Data<wbr>Bar for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind DATA_BAR"
|
||||
desc: "Static value DataBar for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DATA_BAR_EXPANDED"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DATA_BAR_EXPANDED"
|
||||
name: "DATA_BAR_EXPANDED"
|
||||
nameWithType: "DocumentBarcodeKind.DATA_BAR_EXPANDED"
|
||||
summary: "Static value Data<wbr>Bar<wbr>Expanded for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind DATA_BAR_EXPANDED"
|
||||
desc: "Static value DataBarExpanded for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DATA_MATRIX"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.DATA_MATRIX"
|
||||
name: "DATA_MATRIX"
|
||||
nameWithType: "DocumentBarcodeKind.DATA_MATRIX"
|
||||
summary: "Static value Data<wbr>Matrix for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind DATA_MATRIX"
|
||||
desc: "Static value DataMatrix for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.EAN_13"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.EAN_13"
|
||||
name: "EAN_13"
|
||||
nameWithType: "DocumentBarcodeKind.EAN_13"
|
||||
summary: "Static value EAN13 for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind EAN_13"
|
||||
desc: "Static value EAN13 for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.EAN_8"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.EAN_8"
|
||||
name: "EAN_8"
|
||||
nameWithType: "DocumentBarcodeKind.EAN_8"
|
||||
summary: "Static value EAN8 for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind EAN_8"
|
||||
desc: "Static value EAN8 for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.ITF"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.ITF"
|
||||
name: "ITF"
|
||||
nameWithType: "DocumentBarcodeKind.ITF"
|
||||
summary: "Static value ITF for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind ITF"
|
||||
desc: "Static value ITF for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.MAXI_CODE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.MAXI_CODE"
|
||||
name: "MAXI_CODE"
|
||||
nameWithType: "DocumentBarcodeKind.MAXI_CODE"
|
||||
summary: "Static value Maxi<wbr>Code for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind MAXI_CODE"
|
||||
desc: "Static value MaxiCode for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.MICRO_QRCODE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.MICRO_QRCODE"
|
||||
name: "MICRO_QRCODE"
|
||||
nameWithType: "DocumentBarcodeKind.MICRO_QRCODE"
|
||||
summary: "Static value Micro<wbr>QRCode for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind MICRO_QRCODE"
|
||||
desc: "Static value MicroQRCode for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.PDF_417"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.PDF_417"
|
||||
name: "PDF_417"
|
||||
nameWithType: "DocumentBarcodeKind.PDF_417"
|
||||
summary: "Static value PDF417 for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind PDF_417"
|
||||
desc: "Static value PDF417 for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.QRCODE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.QRCODE"
|
||||
name: "QRCODE"
|
||||
nameWithType: "DocumentBarcodeKind.QRCODE"
|
||||
summary: "Static value QRCode for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind QRCODE"
|
||||
desc: "Static value QRCode for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.UPCA"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.UPCA"
|
||||
name: "UPCA"
|
||||
nameWithType: "DocumentBarcodeKind.UPCA"
|
||||
summary: "Static value UPCA for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind UPCA"
|
||||
desc: "Static value UPCA for DocumentBarcodeKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.UPCE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.UPCE"
|
||||
name: "UPCE"
|
||||
nameWithType: "DocumentBarcodeKind.UPCE"
|
||||
summary: "Static value UPCE for Document<wbr>Barcode<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentBarcodeKind UPCE"
|
||||
desc: "Static value UPCE for DocumentBarcodeKind."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "DocumentBarcodeKind.fromString(String name)"
|
||||
summary: "Creates or finds a Document<wbr>Barcode<wbr>Kind from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static DocumentBarcodeKind fromString(String name)"
|
||||
desc: "Creates or finds a DocumentBarcodeKind from its string representation."
|
||||
returns:
|
||||
description: "the corresponding DocumentBarcodeKind."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.values()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind.values()"
|
||||
name: "values()"
|
||||
nameWithType: "DocumentBarcodeKind.values()"
|
||||
summary: "Gets known Document<wbr>Barcode<wbr>Kind values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<DocumentBarcodeKind> values()"
|
||||
desc: "Gets known DocumentBarcodeKind values."
|
||||
returns:
|
||||
description: "known DocumentBarcodeKind values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind&text=DocumentBarcodeKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Barcode kind."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField"
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField"
|
||||
name: "DocumentField"
|
||||
nameWithType: "DocumentField"
|
||||
summary: "An object representing the content and location of a field value."
|
||||
summary: "Model representing the content and location of a field value."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -47,6 +47,16 @@ methods:
|
|||
returns:
|
||||
description: "the value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.AddressValue?alt=com.azure.ai.formrecognizer.documentanalysis.models.AddressValue&text=AddressValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsBoolean()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsBoolean()"
|
||||
name: "getValueAsBoolean()"
|
||||
nameWithType: "DocumentField.getValueAsBoolean()"
|
||||
summary: "Get boolean value of the field."
|
||||
syntax: "public Boolean getValueAsBoolean()"
|
||||
desc: "Get boolean value of the field."
|
||||
returns:
|
||||
description: "the value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsCountry()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsCountry()"
|
||||
name: "getValueAsCountry()"
|
||||
|
|
@ -168,7 +178,7 @@ methods:
|
|||
description: "the value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/LocalTime.html\">LocalTime</a>"
|
||||
type: "class"
|
||||
desc: "An object representing the content and location of a field value."
|
||||
desc: "Model representing the content and location of a field value."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -45,6 +45,18 @@ fields:
|
|||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType&text=DocumentFieldType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentFieldType ADDRESS"
|
||||
desc: "Static value address for DocumentFieldType."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType.BOOLEAN"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType.BOOLEAN"
|
||||
name: "BOOLEAN"
|
||||
nameWithType: "DocumentFieldType.BOOLEAN"
|
||||
summary: "Static value boolean for Document<wbr>Field<wbr>Type."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType&text=DocumentFieldType\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentFieldType BOOLEAN"
|
||||
desc: "Static value boolean for DocumentFieldType."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType.COUNTRY_REGION"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType.COUNTRY_REGION"
|
||||
name: "COUNTRY_REGION"
|
||||
|
|
@ -220,4 +232,4 @@ type: "class"
|
|||
desc: "Defines values for DocumentFieldType."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula"
|
||||
name: "DocumentFormula"
|
||||
nameWithType: "DocumentFormula"
|
||||
summary: "A formula object."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DocumentFormula**"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.DocumentFormula()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.DocumentFormula()"
|
||||
name: "DocumentFormula()"
|
||||
nameWithType: "DocumentFormula.DocumentFormula()"
|
||||
syntax: "public DocumentFormula()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getBoundingPolygon()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getBoundingPolygon()"
|
||||
name: "getBoundingPolygon()"
|
||||
nameWithType: "DocumentFormula.getBoundingPolygon()"
|
||||
summary: "Get the polygon property: Bounding polygon of the formula."
|
||||
syntax: "public List<Point> getBoundingPolygon()"
|
||||
desc: "Get the polygon property: Bounding polygon of the formula."
|
||||
returns:
|
||||
description: "the polygon value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.Point?alt=com.azure.ai.formrecognizer.documentanalysis.models.Point&text=Point\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getConfidence()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
nameWithType: "DocumentFormula.getConfidence()"
|
||||
summary: "Get the confidence property: Confidence of correctly extracting the formula."
|
||||
syntax: "public float getConfidence()"
|
||||
desc: "Get the confidence property: Confidence of correctly extracting the formula."
|
||||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "DocumentFormula.getKind()"
|
||||
summary: "Get the kind property: Formula kind."
|
||||
syntax: "public DocumentFormulaKind getKind()"
|
||||
desc: "Get the kind property: Formula kind."
|
||||
returns:
|
||||
description: "the kind value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind&text=DocumentFormulaKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getSpan()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getSpan()"
|
||||
name: "getSpan()"
|
||||
nameWithType: "DocumentFormula.getSpan()"
|
||||
summary: "Get the span property: Location of the formula in the reading order concatenated content."
|
||||
syntax: "public DocumentSpan getSpan()"
|
||||
desc: "Get the span property: Location of the formula in the reading order concatenated content."
|
||||
returns:
|
||||
description: "the span value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan&text=DocumentSpan\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getValue()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "DocumentFormula.getValue()"
|
||||
summary: "Get the value property: La<wbr>Tex expression describing the formula."
|
||||
syntax: "public String getValue()"
|
||||
desc: "Get the value property: LaTex expression describing the formula."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "A formula object."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind"
|
||||
name: "DocumentFormulaKind"
|
||||
nameWithType: "DocumentFormulaKind"
|
||||
summary: "Formula kind."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **DocumentFormulaKind**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind&text=DocumentFormulaKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.DocumentFormulaKind()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.DocumentFormulaKind()"
|
||||
name: "DocumentFormulaKind()"
|
||||
nameWithType: "DocumentFormulaKind.DocumentFormulaKind()"
|
||||
summary: "Creates a new instance of Document<wbr>Formula<wbr>Kind value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public DocumentFormulaKind()"
|
||||
desc: "Creates a new instance of DocumentFormulaKind value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.DISPLAY"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.DISPLAY"
|
||||
name: "DISPLAY"
|
||||
nameWithType: "DocumentFormulaKind.DISPLAY"
|
||||
summary: "Static value display for Document<wbr>Formula<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind&text=DocumentFormulaKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentFormulaKind DISPLAY"
|
||||
desc: "Static value display for DocumentFormulaKind."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.INLINE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.INLINE"
|
||||
name: "INLINE"
|
||||
nameWithType: "DocumentFormulaKind.INLINE"
|
||||
summary: "Static value inline for Document<wbr>Formula<wbr>Kind."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind&text=DocumentFormulaKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final DocumentFormulaKind INLINE"
|
||||
desc: "Static value inline for DocumentFormulaKind."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "DocumentFormulaKind.fromString(String name)"
|
||||
summary: "Creates or finds a Document<wbr>Formula<wbr>Kind from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static DocumentFormulaKind fromString(String name)"
|
||||
desc: "Creates or finds a DocumentFormulaKind from its string representation."
|
||||
returns:
|
||||
description: "the corresponding DocumentFormulaKind."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind&text=DocumentFormulaKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.values()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind.values()"
|
||||
name: "values()"
|
||||
nameWithType: "DocumentFormulaKind.values()"
|
||||
summary: "Gets known Document<wbr>Formula<wbr>Kind values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<DocumentFormulaKind> values()"
|
||||
desc: "Gets known DocumentFormulaKind values."
|
||||
returns:
|
||||
description: "known DocumentFormulaKind values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind&text=DocumentFormulaKind\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Formula kind."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -62,4 +62,4 @@ type: "class"
|
|||
desc: "An object representing the field key or value in a key-value pair."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -62,4 +62,4 @@ type: "class"
|
|||
desc: "An object representing a form field with distinct field label (key) and field value (may be empty)."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -62,4 +62,4 @@ type: "class"
|
|||
desc: "An object representing the detected language for a given text span."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -72,4 +72,4 @@ type: "class"
|
|||
desc: "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -32,19 +32,39 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getAngle()"
|
||||
name: "getAngle()"
|
||||
nameWithType: "DocumentPage.getAngle()"
|
||||
summary: "Get the angle property: The general orientation of the content in clockwise direction, measured in degrees between (-180, 180\\]."
|
||||
summary: "Get the general orientation of the content in clockwise direction, measured in degrees between (-180, 180\\]."
|
||||
syntax: "public Float getAngle()"
|
||||
desc: "Get the angle property: The general orientation of the content in clockwise direction, measured in degrees between (-180, 180\\]."
|
||||
desc: "Get the general orientation of the content in clockwise direction, measured in degrees between (-180, 180\\]."
|
||||
returns:
|
||||
description: "the angle value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getBarcodes()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getBarcodes()"
|
||||
name: "getBarcodes()"
|
||||
nameWithType: "DocumentPage.getBarcodes()"
|
||||
summary: "Get the extracted barcodes from the page."
|
||||
syntax: "public List<DocumentBarcode> getBarcodes()"
|
||||
desc: "Get the extracted barcodes from the page."
|
||||
returns:
|
||||
description: "the barcodes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode&text=DocumentBarcode\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getFormulas()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getFormulas()"
|
||||
name: "getFormulas()"
|
||||
nameWithType: "DocumentPage.getFormulas()"
|
||||
summary: "Get the extracted formulas from the page."
|
||||
syntax: "public List<DocumentFormula> getFormulas()"
|
||||
desc: "Get the extracted formulas from the page."
|
||||
returns:
|
||||
description: "the formulas value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula&text=DocumentFormula\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getHeight()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getHeight()"
|
||||
name: "getHeight()"
|
||||
nameWithType: "DocumentPage.getHeight()"
|
||||
summary: "Get the height property: The height of the image/PDF in pixels/inches, respectively."
|
||||
summary: "Get the height of the image/PDF in pixels/inches, respectively."
|
||||
syntax: "public Float getHeight()"
|
||||
desc: "Get the height property: The height of the image/PDF in pixels/inches, respectively."
|
||||
desc: "Get the height of the image/PDF in pixels/inches, respectively."
|
||||
returns:
|
||||
description: "the height value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
|
||||
|
|
@ -52,9 +72,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getLines()"
|
||||
name: "getLines()"
|
||||
nameWithType: "DocumentPage.getLines()"
|
||||
summary: "Get the lines property: Extracted lines from the page, potentially containing both textual and visual elements."
|
||||
summary: "Get the extracted lines from the page, potentially containing both textual and visual elements."
|
||||
syntax: "public List<DocumentLine> getLines()"
|
||||
desc: "Get the lines property: Extracted lines from the page, potentially containing both textual and visual elements."
|
||||
desc: "Get the extracted lines from the page, potentially containing both textual and visual elements."
|
||||
returns:
|
||||
description: "the lines value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentLine?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentLine&text=DocumentLine\" data-throw-if-not-resolved=\"False\" />>"
|
||||
|
|
@ -62,9 +82,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getPageNumber()"
|
||||
name: "getPageNumber()"
|
||||
nameWithType: "DocumentPage.getPageNumber()"
|
||||
summary: "Get the page<wbr>Number property: 1-based page number in the input document."
|
||||
summary: "Get the 1-based page number in the input document."
|
||||
syntax: "public int getPageNumber()"
|
||||
desc: "Get the pageNumber property: 1-based page number in the input document."
|
||||
desc: "Get the 1-based page number in the input document."
|
||||
returns:
|
||||
description: "the pageNumber value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -72,9 +92,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getSelectionMarks()"
|
||||
name: "getSelectionMarks()"
|
||||
nameWithType: "DocumentPage.getSelectionMarks()"
|
||||
summary: "Get the selection<wbr>Marks property: Extracted selection marks from the page."
|
||||
summary: "Get the extracted selection marks from the page."
|
||||
syntax: "public List<DocumentSelectionMark> getSelectionMarks()"
|
||||
desc: "Get the selectionMarks property: Extracted selection marks from the page."
|
||||
desc: "Get the extracted selection marks from the page."
|
||||
returns:
|
||||
description: "the selectionMarks value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSelectionMark?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSelectionMark&text=DocumentSelectionMark\" data-throw-if-not-resolved=\"False\" />>"
|
||||
|
|
@ -82,9 +102,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getSpans()"
|
||||
name: "getSpans()"
|
||||
nameWithType: "DocumentPage.getSpans()"
|
||||
summary: "Get the spans property: Location of the page in the reading order concatenated content."
|
||||
summary: "Get the location of the page in the reading order concatenated content."
|
||||
syntax: "public List<DocumentSpan> getSpans()"
|
||||
desc: "Get the spans property: Location of the page in the reading order concatenated content."
|
||||
desc: "Get the location of the page in the reading order concatenated content."
|
||||
returns:
|
||||
description: "the spans value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSpan&text=DocumentSpan\" data-throw-if-not-resolved=\"False\" />>"
|
||||
|
|
@ -92,9 +112,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getUnit()"
|
||||
name: "getUnit()"
|
||||
nameWithType: "DocumentPage.getUnit()"
|
||||
summary: "Get the unit property: The unit used by the width, height, and bounding<wbr>Box properties."
|
||||
summary: "Get the unit used by the width, height, and bounding<wbr>Box properties."
|
||||
syntax: "public DocumentPageLengthUnit getUnit()"
|
||||
desc: "Get the unit property: The unit used by the width, height, and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\"."
|
||||
desc: "Get the unit used by the width, height, and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\"."
|
||||
returns:
|
||||
description: "the unit value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentPageLengthUnit?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentPageLengthUnit&text=DocumentPageLengthUnit\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -102,9 +122,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getWidth()"
|
||||
name: "getWidth()"
|
||||
nameWithType: "DocumentPage.getWidth()"
|
||||
summary: "Get the width property: The width of the image/PDF in pixels/inches, respectively."
|
||||
summary: "Get the width of the image/PDF in pixels/inches, respectively."
|
||||
syntax: "public Float getWidth()"
|
||||
desc: "Get the width property: The width of the image/PDF in pixels/inches, respectively."
|
||||
desc: "Get the width of the image/PDF in pixels/inches, respectively."
|
||||
returns:
|
||||
description: "the width value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
|
||||
|
|
@ -112,9 +132,9 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage.getWords()"
|
||||
name: "getWords()"
|
||||
nameWithType: "DocumentPage.getWords()"
|
||||
summary: "Get the words property: Extracted words from the page."
|
||||
summary: "Get the extracted words from the page."
|
||||
syntax: "public List<DocumentWord> getWords()"
|
||||
desc: "Get the words property: Extracted words from the page."
|
||||
desc: "Get the extracted words from the page."
|
||||
returns:
|
||||
description: "the words value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord&text=DocumentWord\" data-throw-if-not-resolved=\"False\" />>"
|
||||
|
|
@ -122,4 +142,4 @@ type: "class"
|
|||
desc: "Content and layout elements extracted from a page from the input."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -88,4 +88,4 @@ type: "class"
|
|||
desc: "Defines values for DocumentPageLengthUnit."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -72,4 +72,4 @@ type: "class"
|
|||
desc: "A paragraph object consisting with contiguous lines generally with common alignment and spacing."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -72,4 +72,4 @@ type: "class"
|
|||
desc: "A selection mark object representing check boxes, radio buttons, and other elements indicating a selection."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -88,4 +88,4 @@ type: "class"
|
|||
desc: "Defines values for DocumentSelectionMarkState."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -88,4 +88,4 @@ type: "class"
|
|||
desc: "Defines values for DocumentSignatureType."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -52,4 +52,4 @@ type: "class"
|
|||
desc: "Contiguous region of the concatenated content property, specified as an offset and length."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -28,6 +28,26 @@ constructors:
|
|||
nameWithType: "DocumentStyle.DocumentStyle()"
|
||||
syntax: "public DocumentStyle()"
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getBackgroundColor()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getBackgroundColor()"
|
||||
name: "getBackgroundColor()"
|
||||
nameWithType: "DocumentStyle.getBackgroundColor()"
|
||||
summary: "Get the background<wbr>Color property: Background color in \\#rrggbb hexadecimal format.."
|
||||
syntax: "public String getBackgroundColor()"
|
||||
desc: "Get the backgroundColor property: Background color in \\#rrggbb hexadecimal format.."
|
||||
returns:
|
||||
description: "the backgroundColor value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getColor()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getColor()"
|
||||
name: "getColor()"
|
||||
nameWithType: "DocumentStyle.getColor()"
|
||||
summary: "Get the color property: Foreground color in \\#rrggbb hexadecimal format."
|
||||
syntax: "public String getColor()"
|
||||
desc: "Get the color property: Foreground color in \\#rrggbb hexadecimal format."
|
||||
returns:
|
||||
description: "the color value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getConfidence()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getConfidence()"
|
||||
name: "getConfidence()"
|
||||
|
|
@ -38,6 +58,36 @@ methods:
|
|||
returns:
|
||||
description: "the confidence value."
|
||||
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getFontStyle()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getFontStyle()"
|
||||
name: "getFontStyle()"
|
||||
nameWithType: "DocumentStyle.getFontStyle()"
|
||||
summary: "Get the font<wbr>Style property: Font style."
|
||||
syntax: "public FontStyle getFontStyle()"
|
||||
desc: "Get the fontStyle property: Font style."
|
||||
returns:
|
||||
description: "the fontStyle value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontStyle&text=FontStyle\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getFontWeight()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getFontWeight()"
|
||||
name: "getFontWeight()"
|
||||
nameWithType: "DocumentStyle.getFontWeight()"
|
||||
summary: "Get the font<wbr>Weight property: Font weight."
|
||||
syntax: "public FontWeight getFontWeight()"
|
||||
desc: "Get the fontWeight property: Font weight."
|
||||
returns:
|
||||
description: "the fontWeight value."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontWeight&text=FontWeight\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getSimilarFontFamily()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getSimilarFontFamily()"
|
||||
name: "getSimilarFontFamily()"
|
||||
nameWithType: "DocumentStyle.getSimilarFontFamily()"
|
||||
summary: "Get the similar<wbr>Font<wbr>Family property: Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex."
|
||||
syntax: "public String getSimilarFontFamily()"
|
||||
desc: "Get the similarFontFamily property: Visually most similar font from among the set of supported font families, with fallback fonts following CSS convention (ex. 'Arial, sans-serif')."
|
||||
returns:
|
||||
description: "the similarFontFamily value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getSpans()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentStyle.getSpans()"
|
||||
name: "getSpans()"
|
||||
|
|
@ -62,4 +112,4 @@ type: "class"
|
|||
desc: "An object representing observed text styles."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -82,4 +82,4 @@ type: "class"
|
|||
desc: "A table object consisting table cells arranged in a rectangular layout."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -112,4 +112,4 @@ type: "class"
|
|||
desc: "An object representing the location and content of a table cell."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -124,4 +124,4 @@ type: "class"
|
|||
desc: "Defines values for DocumentTableCellKind."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -72,4 +72,4 @@ type: "class"
|
|||
desc: "A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle"
|
||||
name: "FontStyle"
|
||||
nameWithType: "FontStyle"
|
||||
summary: "Font style."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FontStyle**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontStyle&text=FontStyle\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.FontStyle()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.FontStyle()"
|
||||
name: "FontStyle()"
|
||||
nameWithType: "FontStyle.FontStyle()"
|
||||
summary: "Creates a new instance of Font<wbr>Style value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FontStyle()"
|
||||
desc: "Creates a new instance of FontStyle value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.ITALIC"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.ITALIC"
|
||||
name: "ITALIC"
|
||||
nameWithType: "FontStyle.ITALIC"
|
||||
summary: "Static value italic for Font<wbr>Style."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontStyle&text=FontStyle\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FontStyle ITALIC"
|
||||
desc: "Static value italic for FontStyle."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.NORMAL"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.NORMAL"
|
||||
name: "NORMAL"
|
||||
nameWithType: "FontStyle.NORMAL"
|
||||
summary: "Static value normal for Font<wbr>Style."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontStyle&text=FontStyle\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FontStyle NORMAL"
|
||||
desc: "Static value normal for FontStyle."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FontStyle.fromString(String name)"
|
||||
summary: "Creates or finds a Font<wbr>Style from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FontStyle fromString(String name)"
|
||||
desc: "Creates or finds a FontStyle from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FontStyle."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontStyle&text=FontStyle\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.values()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FontStyle.values()"
|
||||
summary: "Gets known Font<wbr>Style values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FontStyle> values()"
|
||||
desc: "Gets known FontStyle values."
|
||||
returns:
|
||||
description: "known FontStyle values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontStyle?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontStyle&text=FontStyle\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Font style."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight"
|
||||
name: "FontWeight"
|
||||
nameWithType: "FontWeight"
|
||||
summary: "Font weight."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
||||
syntax: "public final class **FontWeight**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontWeight&text=FontWeight\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.FontWeight()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.FontWeight()"
|
||||
name: "FontWeight()"
|
||||
nameWithType: "FontWeight.FontWeight()"
|
||||
summary: "Creates a new instance of Font<wbr>Weight value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public FontWeight()"
|
||||
desc: "Creates a new instance of FontWeight value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.BOLD"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.BOLD"
|
||||
name: "BOLD"
|
||||
nameWithType: "FontWeight.BOLD"
|
||||
summary: "Static value bold for Font<wbr>Weight."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontWeight&text=FontWeight\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FontWeight BOLD"
|
||||
desc: "Static value bold for FontWeight."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.NORMAL"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.NORMAL"
|
||||
name: "NORMAL"
|
||||
nameWithType: "FontWeight.NORMAL"
|
||||
summary: "Static value normal for Font<wbr>Weight."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontWeight&text=FontWeight\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final FontWeight NORMAL"
|
||||
desc: "Static value normal for FontWeight."
|
||||
methods:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.fromString(java.lang.String)"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "FontWeight.fromString(String name)"
|
||||
summary: "Creates or finds a Font<wbr>Weight from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static FontWeight fromString(String name)"
|
||||
desc: "Creates or finds a FontWeight from its string representation."
|
||||
returns:
|
||||
description: "the corresponding FontWeight."
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontWeight&text=FontWeight\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.values()"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight.values()"
|
||||
name: "values()"
|
||||
nameWithType: "FontWeight.values()"
|
||||
summary: "Gets known Font<wbr>Weight values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<FontWeight> values()"
|
||||
desc: "Gets known FontWeight values."
|
||||
returns:
|
||||
description: "known FontWeight values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.FontWeight?alt=com.azure.ai.formrecognizer.documentanalysis.models.FontWeight&text=FontWeight\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Font weight."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
@ -42,4 +42,4 @@ type: "class"
|
|||
desc: "The OperationResult model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole"
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole"
|
||||
name: "ParagraphRole"
|
||||
nameWithType: "ParagraphRole"
|
||||
summary: "Defines values for Paragraph<wbr>Role."
|
||||
summary: "Semantic role of the paragraph."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -31,7 +31,11 @@ constructors:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.ParagraphRole()"
|
||||
name: "ParagraphRole()"
|
||||
nameWithType: "ParagraphRole.ParagraphRole()"
|
||||
syntax: "public ParagraphRole()"
|
||||
summary: "Creates a new instance of Paragraph<wbr>Role value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ParagraphRole()"
|
||||
desc: "Creates a new instance of ParagraphRole value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.FOOTNOTE"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.FOOTNOTE"
|
||||
|
|
@ -45,6 +49,18 @@ fields:
|
|||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole?alt=com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole&text=ParagraphRole\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ParagraphRole FOOTNOTE"
|
||||
desc: "Static value footnote for ParagraphRole."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.FORMULA_BLOCK"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.FORMULA_BLOCK"
|
||||
name: "FORMULA_BLOCK"
|
||||
nameWithType: "ParagraphRole.FORMULA_BLOCK"
|
||||
summary: "Static value formula<wbr>Block for Paragraph<wbr>Role."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole?alt=com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole&text=ParagraphRole\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ParagraphRole FORMULA_BLOCK"
|
||||
desc: "Static value formulaBlock for ParagraphRole."
|
||||
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.PAGE_FOOTER"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.PAGE_FOOTER"
|
||||
name: "PAGE_FOOTER"
|
||||
|
|
@ -126,14 +142,16 @@ methods:
|
|||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ParagraphRole.values()"
|
||||
summary: "Gets known Paragraph<wbr>Role values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<ParagraphRole> values()"
|
||||
desc: "Gets known ParagraphRole values."
|
||||
returns:
|
||||
description: "known ParagraphRole values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole?alt=com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole&text=ParagraphRole\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Defines values for ParagraphRole."
|
||||
desc: "Semantic role of the paragraph."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -52,4 +52,4 @@ type: "class"
|
|||
desc: "Represents the x and y coordinates of a vertex."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -95,4 +95,4 @@ typeParameters:
|
|||
desc: "Strongly typed version of <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentField\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DocumentField\"></xref>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
uid: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
fullName: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
name: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
summary: "Package containing model classes to perform operations <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\"></xref> and\n <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\"></xref>."
|
||||
summary: "Package containing the data models for FormRecognizerClient."
|
||||
classes:
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.AddressValue"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.AnalyzeDocumentOptions"
|
||||
|
|
@ -11,8 +11,13 @@ classes:
|
|||
- "com.azure.ai.formrecognizer.documentanalysis.models.BoundingRegion"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisAudience"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentAnalysisFeature"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcode"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentBarcodeKind"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFieldType"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormula"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentFormulaKind"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentKeyValueElement"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentKeyValuePair"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentLanguage"
|
||||
|
|
@ -29,11 +34,13 @@ classes:
|
|||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentTableCell"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentTableCellKind"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.DocumentWord"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.FontStyle"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.FontWeight"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.OperationResult"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.ParagraphRole"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.Point"
|
||||
- "com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField"
|
||||
desc: "Package containing model classes to perform operations <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisAsyncClient\"></xref> and\n <xref uid=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClient\"></xref>."
|
||||
desc: "Package containing the data models for FormRecognizerClient. Extracts content, layout, and structured data from\n documents."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -56,4 +56,4 @@ type: "class"
|
|||
desc: "The configurable options to pass when creating a composed model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -59,4 +59,4 @@ type: "class"
|
|||
desc: "Quadrangle bounding box, with coordinates specified relative to the top-left of the original image"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -93,4 +93,4 @@ type: "class"
|
|||
desc: "The FieldData model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -151,4 +151,4 @@ type: "class"
|
|||
desc: "Represents the strongly-typed value of a field recognized from the input document and provides methods for converting it to the appropriate type."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -115,4 +115,4 @@ methods:
|
|||
desc: "Defines values for FieldValueType."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -114,4 +114,4 @@ type: "class"
|
|||
desc: "Define values for content type supported for local files."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -56,4 +56,4 @@ type: "class"
|
|||
desc: "Represents a form element recognized from the input document. Its text can be a line, a word, the content of a table cell, a selection mark, etc."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -100,4 +100,4 @@ type: "class"
|
|||
desc: "Represents a field recognized in an input document."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -103,4 +103,4 @@ type: "class"
|
|||
desc: "Represents a line of text and its appearance."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -136,4 +136,4 @@ type: "class"
|
|||
desc: "Represents a page recognized from the input document. Contains lines, words, tables, selection marks, and page metadata."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -61,4 +61,4 @@ type: "class"
|
|||
desc: "Represents a page interval from the input document. Page numbers are 1-based.."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -78,4 +78,4 @@ type: "class"
|
|||
desc: "Defines values for the order in which recognized text lines are returned."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -100,4 +100,4 @@ type: "class"
|
|||
desc: "Defines values for FormRecognizerAudience."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -61,4 +61,4 @@ type: "class"
|
|||
desc: "The FormRecognizerError model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -61,4 +61,4 @@ type: "class"
|
|||
desc: "The FormRecognizerErrorInformation model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ methods:
|
|||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "General exception for FormRecognizer client-side related failures."
|
||||
desc: "General exception for FormRecognizer client-side related failures. <xref uid=\"com.azure.ai.formrecognizer.models.FormRecognizerErrorInformation\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerErrorInformation\"></xref>"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -930,4 +930,4 @@ type: "class"
|
|||
desc: "The language code supported on the Form Recognizer service. See supported language codes [here][].\n\n\n[here]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/language-support?tabs=v2-1"
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -114,4 +114,4 @@ type: "class"
|
|||
desc: "Defines values for FormRecognizerLocale."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -48,4 +48,4 @@ type: "class"
|
|||
desc: "The FormRecognizerOperationResult model."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -100,4 +100,4 @@ type: "class"
|
|||
desc: "Represents a selection mark recognized from the input document."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -97,4 +97,4 @@ type: "class"
|
|||
desc: "Represents a table recognized from the input document."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -184,4 +184,4 @@ type: "class"
|
|||
desc: "Represents a cell contained in a table recognized from the input document."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -93,4 +93,4 @@ type: "class"
|
|||
desc: "Represents a word recognized from the input document."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ uid: "com.azure.ai.formrecognizer.models.LengthUnit"
|
|||
fullName: "com.azure.ai.formrecognizer.models.LengthUnit"
|
||||
name: "LengthUnit"
|
||||
nameWithType: "LengthUnit"
|
||||
summary: "Defines values for Length<wbr>Unit."
|
||||
summary: "The unit used by the width, height and bounding<wbr>Box properties."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
|
|
@ -88,7 +88,7 @@ methods:
|
|||
syntax: "public static LengthUnit[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.ai.formrecognizer.models.LengthUnit?alt=com.azure.ai.formrecognizer.models.LengthUnit&text=LengthUnit\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Defines values for LengthUnit."
|
||||
desc: "The unit used by the width, height and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\"."
|
||||
metadata: {}
|
||||
package: "com.azure.ai.formrecognizer.models"
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.0.8
|
||||
artifact: com.azure:azure-ai-formrecognizer:4.1.0
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче