Skip to content

Commit a1b6284

Browse files
Merge pull request #248261 from laujan/query-field-update
update query
2 parents bfd11fe + d73f12b commit a1b6284

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

articles/ai-services/document-intelligence/concept-query-fields.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Document Intelligence now supports query field extractions using Azure OpenAI ca
2020

2121
> [!NOTE]
2222
>
23-
> Document Intelligence Studio query field extraction is currently available with the general document model for the `2023-02-28-preview` release.
23+
> Document Intelligence Studio query field extraction is currently available with the general document model starting with the `2023-02-28-preview` and later releases.
2424
2525
## Select query fields
2626

2727
For query field extraction, specify the fields you want to extract and Document Intelligence analyzes the document accordingly. Here's an example:
2828

29-
* If you're processing a contract in the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/document). Use the `2023-02-28-preview` version:
29+
* If you're processing a contract in the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/document), use the `2023-07-31` version:
3030

3131
:::image type="content" source="media/studio/query-fields.png" alt-text="Screenshot of the query fields button in Document Intelligence Studio.":::
3232

@@ -43,7 +43,7 @@ For query field extraction, specify the fields you want to extract and Document
4343
Use the query fields feature with the [general document model](concept-general-document.md), to add fields to the extraction process without having to train a custom model:
4444

4545
```http
46-
POST https://*.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-document:analyze?api-version=2023-02-28-preview&queryFields=Party1, Party2, PaymentDate HTTP/1.1
46+
POST https://{endpoint}/formrecognizer/documentModels/prebuilt-document:analyze?api-version=2023-07-31&queryFields=Party1, Party2, PaymentDate HTTP/1.1
4747
Host: *.cognitiveservices.azure.com
4848
Content-Type: application/json
4949
Ocp-Apim-Subscription-Key:

articles/ai-services/document-intelligence/how-to-guides/includes/v3-0/rest-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ curl -i -X POST "%FR_ENDPOINT%formrecognizer/documentModels/{modelID}:analyze?ap
7777

7878
**Enable add-on capabilities
7979

80-
To enable add-on capabilities, use the `features` query parameter in the POST request. There are four add-on capabilities available for the 2023-02-28-preview: *ocr.highResolution*, *ocr.formula*, *ocr.font*, and *queryFields.premium*. To learn more about each of the capabilities, visit the [Add-On Capabilities concept page](../../../concept-accuracy-confidence.md). You can only call the highResolution, formula and font capabilities for the Read and Layout model, and the queryFields capability for the General Documents model. The following example shows how to call the highResolution, formula and font capabilities for the Layout model.
80+
To enable add-on capabilities, use the `features` query parameter in the POST request. There are four add-on capabilities available with the 2023-07-31 (GA) release: *ocr.highResolution*, *ocr.formula*, *ocr.font*, and *queryFields.premium*. To learn more about each of the capabilities, visit the [Add-On Capabilities concept page](../../../concept-accuracy-confidence.md). You can only call the highResolution, formula and font capabilities for the Read and Layout model, and the queryFields capability for the General Documents model. The following example shows how to call the highResolution, formula and font capabilities for the Layout model.
8181

8282
```bash
83-
curl -i -X POST "%FR_ENDPOINT%formrecognizer/documentModels/prebuilt-layout:analyze?features=ocr.highResolution,ocr.formula,ocr.font?api-version=2023-02-28-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %FR_KEY%" --data-ascii "{'urlSource': '{document-url}'}"
83+
curl -i -X POST "%FR_ENDPOINT%formrecognizer/documentModels/prebuilt-layout:analyze?features=ocr.highResolution,ocr.formula,ocr.font?api-version=2023-07-31" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %FR_KEY%" --data-ascii "{'urlSource': '{document-url}'}"
8484
```
8585

8686
### POST response

articles/ai-services/document-intelligence/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ You can use Document Intelligence to automate document processing in application
248248

249249
| About | Development options |
250250
|----------|--------------|
251-
|Extract contract agreement and party details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=contract)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-02-28-preview/operations/AnalyzeDocument)
251+
|Extract contract agreement and party details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=contract)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/AnalyzeDocument)
252252

253253
> [!div class="nextstepaction"]
254254
> [Return to model types](#prebuilt-models)
@@ -333,7 +333,7 @@ You can use Document Intelligence to automate document processing in application
333333

334334
| About | Development options |
335335
|----------|--------------|
336-
|Extract mortgage interest information and details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=tax.us.1098)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-02-28-preview/operations/AnalyzeDocument)
336+
|Extract mortgage interest information and details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=tax.us.1098)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/AnalyzeDocument)
337337

338338
> [!div class="nextstepaction"]
339339
> [Return to model types](#prebuilt-models)
@@ -344,7 +344,7 @@ You can use Document Intelligence to automate document processing in application
344344

345345
| About | Development options |
346346
|----------|--------------|
347-
|Extract student loan information and details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=tax.us.1098E)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-02-28-preview/operations/AnalyzeDocument)
347+
|Extract student loan information and details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=tax.us.1098E)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/AnalyzeDocument)
348348

349349
> [!div class="nextstepaction"]
350350
> [Return to model types](#prebuilt-models)
@@ -355,7 +355,7 @@ You can use Document Intelligence to automate document processing in application
355355

356356
| About | Development options |
357357
|----------|--------------|
358-
|Extract tuition information and details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=tax.us.1098T)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-02-28-preview/operations/AnalyzeDocument)
358+
|Extract tuition information and details.|&#9679; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=tax.us.1098T)</br>&#9679; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2023-07-31/operations/AnalyzeDocument)
359359

360360
> [!div class="nextstepaction"]
361361
> [Return to model types](#prebuilt-models)

0 commit comments

Comments
 (0)