@azure-rest/ai-document-intelligence 1.0.0-alpha.20250109.1 → 1.0.0-alpha.20250113.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -12
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Key links:
|
|
|
10
10
|
|
|
11
11
|
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest)
|
|
12
12
|
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence)
|
|
13
|
-
- [API reference documentation](https://
|
|
13
|
+
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/ai-document-intelligence?view=azure-node-preview)
|
|
14
14
|
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples)
|
|
15
15
|
- [Changelog](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md)
|
|
16
16
|
- [Migration Guide from Form Recognizer](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/MIGRATION-FR_v4-DI_v1.md)
|
|
@@ -19,19 +19,19 @@ Key links:
|
|
|
19
19
|
|
|
20
20
|
This table shows the relationship between SDK versions and supported API versions of the service:
|
|
21
21
|
|
|
22
|
-
| SDK version
|
|
23
|
-
|
|
|
24
|
-
| 1.0.0
|
|
22
|
+
| SDK version | Supported API version of service |
|
|
23
|
+
| ----------- | -------------------------------- |
|
|
24
|
+
| 1.0.0 | 2024-11-30 |
|
|
25
25
|
|
|
26
26
|
> Please rely on the older `@azure/ai-form-recognizer` library through the older service API versions for retired models, such as `"prebuilt-businessCard"` and `"prebuilt-document"`. For more information, see [Changelog](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/CHANGELOG.md).
|
|
27
27
|
|
|
28
28
|
The below table describes the relationship of each client and its supported API version(s):
|
|
29
29
|
|
|
30
|
-
| Service API version | Supported clients | Package
|
|
31
|
-
| ------------------- | ------------------------------------------------------------ |
|
|
32
|
-
| 2024-11-30 | DocumentIntelligenceClient | `@azure-rest/ai-document-intelligence` version `1.0.0`
|
|
33
|
-
| 2023-07-31 | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^5.0.0`
|
|
34
|
-
| 2022-08-01 | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^4.0.0`
|
|
30
|
+
| Service API version | Supported clients | Package |
|
|
31
|
+
| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------ |
|
|
32
|
+
| 2024-11-30 | DocumentIntelligenceClient | `@azure-rest/ai-document-intelligence` version `1.0.0` |
|
|
33
|
+
| 2023-07-31 | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^5.0.0` |
|
|
34
|
+
| 2022-08-01 | DocumentAnalysisClient and DocumentModelAdministrationClient | `@azure/ai-form-recognizer` version `^4.0.0` |
|
|
35
35
|
|
|
36
36
|
## Getting started
|
|
37
37
|
|
|
@@ -73,7 +73,7 @@ import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
|
|
|
73
73
|
|
|
74
74
|
const client = DocumentIntelligence(
|
|
75
75
|
process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
|
|
76
|
-
new DefaultAzureCredential()
|
|
76
|
+
new DefaultAzureCredential(),
|
|
77
77
|
);
|
|
78
78
|
```
|
|
79
79
|
|
|
@@ -328,7 +328,7 @@ const output = await client
|
|
|
328
328
|
.path(
|
|
329
329
|
"/documentModels/{modelId}/analyzeResults/{resultId}/pdf",
|
|
330
330
|
"prebuilt-read",
|
|
331
|
-
parseResultIdFromResponse(initialResponse)
|
|
331
|
+
parseResultIdFromResponse(initialResponse),
|
|
332
332
|
)
|
|
333
333
|
.get()
|
|
334
334
|
.asNodeStream(); // output.body would be NodeJS.ReadableStream
|
|
@@ -377,7 +377,7 @@ const output = await client
|
|
|
377
377
|
"/documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}",
|
|
378
378
|
"prebuilt-layout",
|
|
379
379
|
parseResultIdFromResponse(initialResponse),
|
|
380
|
-
figureId
|
|
380
|
+
figureId,
|
|
381
381
|
)
|
|
382
382
|
.get()
|
|
383
383
|
.asNodeStream(); // output.body would be NodeJS.ReadableStream
|