View Diff on GitHub
Highlights
この差分では、いくつかの技術ドキュメントの軽微な更新が行われています。新しい機能の追加や大きな破壊的変更は含まれていませんが、ドキュメントの正確性とユーザビリティを向上させるための細かな改良が施されています。
New features
特に新機能の追加はありませんが、既存のコンテンツの更新が行われました。
Breaking changes
破壊的な変更はありません。
Other updates
- 各ドキュメントの投稿日が2025年2月7日に更新され、最新の情報が提供されています。
- C# SDKとREST APIに関するドキュメントでは、表現やコマンドの一貫性が改善されています。
- 画像ファイルがいくつか更新され、視覚的な情報の正確性が向上しています。
Insights
この差分では、主に技術ドキュメントのメンテナンス的な更新が行われています。投稿日を新しいものに更新することにより、ユーザーは常に最新の情報にアクセスできるようになります。これは、ユーザーがサービスを利用する際に正確な情報を得るために重要なステップです。
特に、コマンドや表現の変更は、技術ドキュメントにおける明確さと一貫性を強化するものです。例えば、C# SDKのガイドでは「pre-existing code」が「existing code」に変更されており、これは多くのユーザーにとって指示がより直接的で理解しやすくなる修正です。
REST API関連の更新では、コマンドの記述における環境に適した用語の使用やサンプルコードのリンクの更新が含まれています。こうした改良は、ユーザーが迅速に問題を解決したり、新しい機能を試したりするときの障壁を下げます。
さらに、ドキュメント内の画像ファイルが新しいバージョンに更新されています。具体的な変更内容が詳細に記載されていないため、視覚的な改善点は確認できませんが、一般的には最新のUIや機能を反映するための更新と考えられます。最新の視覚情報を含めることで、ユーザーが正確かつ迅速に理解できる環境が整えられています。
総じて、この一連の更新は、製品やサービスの利用者に最新かつ最適な情報を届けることを目的としており、技術文書の管理とユーザーエクスペリエンスを向上させるものです。
Summary Table
Modified Contents
articles/ai-services/document-intelligence/concept/retrieval-augmented-generation.md
Diff
@@ -6,7 +6,7 @@ author: laujan
manager: nitinme
ms.service: azure-ai-document-intelligence
ms.topic: conceptual
-ms.date: 11/19/2024
+ms.date: 02/07/2025
ms.author: lajanuar
monikerRange: '>=doc-intel-3.1.0'
---
Summary
{
"modification_type": "minor update",
"modification_title": "ドキュメント投稿日を更新"
}
Explanation
この変更は、ドキュメントの更新日を変更するマイナーアップデートです。具体的には、retrieval-augmented-generation.md
ファイル内の投稿日が2024年11月19日から2025年2月7日に更新されました。この変更は、コンテンツの正確性を維持するためのものであり、特に文書の管理や運用において、ユーザーに最新の情報を提供することを目的としています。ファイルの内容に関する他の変更はなく、全体としての構成や内容は変わっていません。
articles/ai-services/document-intelligence/how-to-guides/includes/v4-0/csharp-sdk.md
Diff
@@ -5,7 +5,7 @@ author: laujan
manager: nitinme
ms.service: azure-ai-document-intelligence
ms.topic: include
-ms.date: 11/19/2024
+ms.date: 02/07/2025
ms.author: lajanuar
ms.custom: devx-track-csharp, linux-related-content
monikerRange: 'doc-intel-4.0.0'
@@ -88,7 +88,7 @@ monikerRange: 'doc-intel-4.0.0'
1. Open the *Program.cs* file.
-1. Delete the pre-existing code, including the line `Console.Writeline("Hello World!")`.
+1. Delete the existing code, including the line `Console.Writeline("Hello World!")`.
1. Select one of the following code samples and copy/paste into your application's *Program.cs* file:
Summary
{
"modification_type": "minor update",
"modification_title": "C# SDK ガイドのテキストを修正"
}
Explanation
この変更では、C# SDKに関するガイドの内容が軽微に更新されました。主な修正は、文書内の投稿日が2024年11月19日から2025年2月7日に更新されたことと、特定の手順における表現の調整です。具体的には、既存のコードを削除する際の指示が「pre-existing code」から「existing code」に変更され、より明確な表現になっています。これにより、指示が一貫性を持ち、理解しやすくなります。全体として、ドキュメントの正確性を高め、ユーザーにとってより良い体験を提供するためのマイナーな更新です。
articles/ai-services/document-intelligence/how-to-guides/includes/v4-0/rest-api.md
Diff
@@ -6,7 +6,7 @@ manager: nitinme
ms.service: azure-ai-document-intelligence
ms.custom: linux-related-content
ms.topic: include
-ms.date: 11/19/2024
+ms.date: 02/07/2025
ms.author: lajanuar
---
<!-- markdownlint-disable MD033 -->
@@ -16,14 +16,14 @@ ms.author: lajanuar
>
> This project uses cURL command-line tool to execute REST API calls.
-| [Document Intelligence REST API](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Supported Azure SDKS](../../../sdk-overview-v4-0.md)
+| [Document Intelligence REST API](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true) | [Supported Azure `SDK`s](../../../sdk-overview-v4-0.md)
## Prerequisites
- An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services/).
- The cURL command line tool installed. Windows 10 and Windows 11 ship with a copy of cURL. At a command prompt, type the following cURL command. If the help options display, cURL is installed in your Windows environment.
- ```console
+ ```bash
curl -help
```
@@ -60,18 +60,18 @@ Use the following table as a reference. Replace *\<modelId>* and *\<document-url
## POST request
-Open a console window and run the following cURL command. The commands include the endpoint and key environment variables previously created in the set environment variables section. Replace those variables if your variable names differ. Remember to replace the *\<modelId>* and *\<document-url>* parameters.
+Open a bash window and run the following cURL command. The commands include the endpoint and key environment variables previously created in the set environment variables section. Replace those variables if your variable names differ. Remember to replace the *\<modelId>* and *\<document-url>* parameters.
-```console
-curl -i -X POST "%DI_ENDPOINT%/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" --data-ascii "{'urlSource': '<document-url>'}"
+```bash
+curl -i -X POST "POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: {DI_KEY}" --data-ascii "{'urlSource': '<document-url>'}"
```
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) and later releases: *ocr.highResolution*, *ocr.formula*, *ocr.font*, and *queryFields.premium*. To learn more about each of the capabilities, see [Custom models](../../../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.
```bash
-curl -i -X POST "%DI_ENDPOINT%documentintelligence/documentModels/prebuilt-layout:analyze?features=ocr.highResolution,ocr.formula,ocr.font?api-version=2024-02-29-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" --data-ascii "{'urlSource': '<document-url>'}"
+curl -i -X POST "{endpoint}/documentintelligence/documentModels/prebuilt-layout:analyze?features=ocr.highResolution,ocr.formula,ocr.font?api-version=2024-11-30" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: {DI_KEY}" --data-ascii "{'urlSource': '<document-url>'}"
```
### POST response
@@ -82,7 +82,7 @@ You receive a `202 (Success)` response that includes an `Operation-location` hea
### Get analyze result (GET Request)
-After you call the [`Analyze document`](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) API, call the [`Get analyze` result}(/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) API to get the status of the operation and the extracted data.
+After you call the [`Analyze document`](/rest/api/aiservices/document-models/analyze-batch-documents?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true&tabs=HTTP) API, call the [`Get analyze` result](/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true&tabs=HTTP) API to get the status of the operation and the extracted data.
<!-- markdownlint-disable MD024 -->
@@ -92,16 +92,16 @@ The cURL command line tool doesn't format API responses that contain JSON conten
Use the NodeJS *json tool* as a JSON formatter for cURL. If you don't have [Node.js](https://nodejs.org/) installed, download and install the latest version.
-1. Open a console window and install the json tool by using the following command:
+1. Open a bash window and install the json tool by using the following command:
- ```console
+ ```bash
npm install -g jsontool
```
1. Pretty print the JSON output by including the pipe character `| json` with your GET requests.
- ```console
- curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json
+ ```bash
+ curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-11-30"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json
```
#### [macOS](#tab/macOS)
@@ -110,8 +110,8 @@ The *json_pp* command tool ships with macOS and can be used as a JSON formatter
- Pretty print the JSON output by including `| json_pp` with your GET requests.
- ```console
- curl -i -X GET "{endpoint}documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
+ ```bash
+ curl -i -X GET "{endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2024-11-30"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
```
#### [Linux](#tab/linux)
@@ -120,8 +120,8 @@ The *json_pp* command line tool is preinstalled in most Linux distributions. If
- Pretty print the JSON output by including `| json_pp` with your `GET` requests.
- ```console
- curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
+ ```bash
+ curl -i -X GET "{endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2024-11-30"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
```
---
@@ -134,8 +134,8 @@ Before you run the following command, make these changes:
- Replace *\<DI_KEY* with the variable for your environment variable if it differs from the name in the code.
- Replace *\<json-tool> with your JSON formatting tool.
-```console
-curl -i -X GET "<POST response>" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" | `<json-tool>`
+```bash
+curl -i -X GET "<POST response>" -H "Ocp-Apim-Subscription-Key: {DI_KEY}" | `<json-tool>`
```
### Examine the response
Summary
{
"modification_type": "minor update",
"modification_title": "REST API ドキュメントの更新"
}
Explanation
この変更は、REST APIに関するドキュメントの内容を更新したマイナーアップデートです。主な更新点は以下の通りです:
- ドキュメントの日付が2024年11月19日から2025年2月7日に変更されました。
- コマンドプロンプトの指示が「console」から「bash」に変更され、環境に応じた用語の整合性が取られました。
- cURL コマンドの構文にいくつかの調整が加わり、正確性と一貫性が向上しています。具体的には、サンプルコマンドの API エンドポイントやリクエストパラメータが最新のバージョンに対応するよう変更されています。
- 一部のリンクや参照が最新のパスに更新され、適切なリソースへのアクセスが容易になっています。
全体として、このアップデートは文書の正確性とユーザーに対する指示の明確さを向上させるものであり、APIの使用に関する実用的な情報が強化されています。
articles/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api.md
Diff
@@ -7,7 +7,7 @@ manager: nitinme
ms.service: azure-ai-document-intelligence
ms.custom: devx-track-dotnet, devx-track-extended-java, devx-track-js, devx-track-python, linux-related-content
ms.topic: how-to
-ms.date: 11/19/2024
+ms.date: 02/07/2025
ms.author: lajanuar
zone_pivot_groups: programming-languages-set-formre
---
Summary
{
"modification_type": "minor update",
"modification_title": "SDKとREST APIの使用に関するドキュメント更新"
}
Explanation
この変更では、SDKとREST APIの使用に関するガイドのドキュメントが軽微に更新されました。主な変更点は、ドキュメントの日付が2024年11月19日から2025年2月7日に更新されたことです。この日付更新は、情報の新しさと正確さを保証するために重要です。また、文書内の他のメタデータはそのまま維持されており、全体的なコンテンツの整合性が保たれています。このマイナーアップデートは、ユーザーが最新の情報をもとに作業できるようにするためのものです。
articles/ai-services/document-intelligence/media/rag/azure-rag-processing.png
Summary
{
"modification_type": "minor update",
"modification_title": "画像の更新"
}
Explanation
この変更は、ドキュメント内の画像ファイルである「azure-rag-processing.png」に関するもので、具体的な追加や削除はありませんが、画像自体が何らかの形で更新されたことを示しています。一般的に、画像の更新は、ビジュアルコンテンツの正確性や関連性を向上させるために行われるものであり、文書の全体的な質を高める役割を果たします。このマイナーアップデートは、関連する技術情報を視覚的にサポートするための重要なステップと見なされます。
articles/ai-services/document-intelligence/prebuilt/batch-analysis.md
Diff
@@ -5,7 +5,7 @@ description: Learn about the Document Intelligence Batch analysis API
author: laujan
ms.service: azure-ai-document-intelligence
ms.topic: conceptual
-ms.date: 11/19/2024
+ms.date: 02/07/2025
ms.author: lajanuar
monikerRange: '>=doc-intel-4.0.0'
---
@@ -250,4 +250,4 @@ The batch analysis results help you identify which files are successfully analyz
## Next steps
-[View code samples on GitHub.](https://github.com/Azure-Samples/document-intelligence-code-samples/tree/main/Python(v4.0)/Prebuilt_model)
\ No newline at end of file
+[View code samples on GitHub.](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/documentintelligence/azure-ai-documentintelligence/samples/sample_analyze_batch_documents.py)
Summary
{
"modification_type": "minor update",
"modification_title": "バッチ分析ドキュメントの更新"
}
Explanation
この変更は、バッチ分析に関するドキュメント「batch-analysis.md」の軽微な更新を示しています。主な変更点は以下の通りです:
- ドキュメントの日付が2024年11月19日から2025年2月7日に更新され、情報の新しさを反映しています。
- GitHubでのコードサンプルへのリンクが更新され、新しいリンクが提供されています。この変更により、ユーザーが最新のサンプルコードへアクセスできるようになり、具体的な実装例に基づいてより良い理解が得られることが期待されます。
このようなマイナーアップデートは、文書の関連性を保ちつつ、ユーザーに最新の情報を提供するために重要です。
articles/ai-services/document-intelligence/quickstarts/includes/rest-api.md
Diff
@@ -6,7 +6,7 @@ author: laujan
manager: nitinme
ms.service: azure-ai-document-intelligence
ms.topic: include
-ms.date: 11/19/2024
+ms.date: 02/07/2025
ms.author: lajanuar
---
@@ -47,7 +47,7 @@ In this quickstart, learn to use the Document Intelligence REST API to analyze a
* A Document Intelligence (single-service) or Azure AI services (multi-service) resource. Once you have your Azure subscription, create a [single-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [multi-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAIServices) Document Intelligence resource, in the Azure portal, to get your key and endpoint. You can use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
> [!TIP]
-> Create an Azure AI services resource if you plan to access multiple Azure AI services under a single endpoint/key. For Document Intelligence access only, create a Document Intelligence resource. Please note that you'll need a single-service resource if you intend to use [Microsoft Entra authentication](/azure/active-directory/authentication/overview-authentication).
+> Create an Azure AI services resource if you plan to access multiple Azure AI services under a single endpoint/key. For Document Intelligence access only, create a Document Intelligence resource. You need a single-service resource if you intend to use [Microsoft Entra authentication](/azure/active-directory/authentication/overview-authentication).
* After your resource deploys, select **Go to resource**. You need the key and endpoint from the resource you create to connect your application to the Document Intelligence API. You paste your key and endpoint into the code later in the quickstart:
@@ -75,13 +75,13 @@ Before you run the cURL command, make the following changes to the [post request
| **Feature** | **{modelID}** | **{your-document-url}** |
| --- | --- |--|
-| **Read** | prebuilt-read | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png` |
-| **Layout** | prebuilt-layout | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png` |
-| **Health insurance card** | prebuilt-healthInsuranceCard.us | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/insurance-card.png` |
-| **W-2** | prebuilt-tax.us.w2 | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png` |
-| **Invoice** | prebuilt-invoice | `https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf` |
-| **Receipt** | prebuilt-receipt | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png` |
-| **ID document** | prebuilt-idDocument | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png` |
+| **Read** | `prebuilt-read` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png` |
+| **Layout** | `prebuilt-layout` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png` |
+| **Health insurance card** | `prebuilt-healthInsuranceCard.us` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/insurance-card.png` |
+| **W-2** | `prebuilt-tax.us.w2` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png` |
+| **Invoice** | `prebuilt-invoice` | `https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf` |
+| **Receipt** | `prebuilt-receipt` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png` |
+| **ID document** | `prebuilt-idDocument` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png` |
:::moniker-end
:::moniker range="doc-intel-3.1.0 || doc-intel-3.0.0"
@@ -90,15 +90,15 @@ Before you run the cURL command, make the following changes to the [post request
| **Feature** | **{modelID}** | **{your-document-url}** |
| --- | --- |--|
-| **General Document** | prebuilt-document | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf` |
-| **Read** | prebuilt-read | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png` |
-| **Layout** | prebuilt-layout | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png` |
-| **Health insurance card** | prebuilt-healthInsuranceCard.us | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/insurance-card.png` |
-| **W-2** | prebuilt-tax.us.w2 | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png` |
-| **Invoice** | prebuilt-invoice | `https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf` |
-| **Receipt** | prebuilt-receipt | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png` |
-| **ID document** | prebuilt-idDocument | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png` |
-| **Business card** | prebuilt-businessCard | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/de5e0d8982ab754823c54de47a47e8e499351523/curl/form-recognizer/rest-api/business_card.jpg` |
+| **General Document** | `prebuilt-document` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf` |
+| **Read** | `prebuilt-read` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png` |
+| **Layout** | `prebuilt-layout` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png` |
+| **Health insurance card** | `prebuilt-healthInsuranceCard.us` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/insurance-card.png` |
+| **W-2** | `prebuilt-tax.us.w2` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png` |
+| **Invoice** | `prebuilt-invoice` | `https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf` |
+| **Receipt** | `prebuilt-receipt` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png` |
+| **ID document** | `prebuilt-idDocument` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png` |
+| **Business card** | `prebuilt-businessCard` | `https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/de5e0d8982ab754823c54de47a47e8e499351523/curl/form-recognizer/rest-api/business_card.jpg` |
:::moniker-end
> [!IMPORTANT]
Summary
{
"modification_type": "minor update",
"modification_title": "REST APIドキュメントの更新"
}
Explanation
この変更は、Document Intelligenceに関するREST APIのクイックスタートガイドの一部を含む「rest-api.md」の内容を更新したもので、次のポイントが含まれています:
- ドキュメントの日付が2024年11月19日から2025年2月7日に変更され、情報の新しさを反映しています。
- コードサンプルのリンクが更新され、具体的なURLが記載されています。これにより、ユーザーは常に最新のサンプルコードにアクセスできるようになります。
- テーブルのフォーマットが整えられ、各アクションのモデルIDや関連するドキュメントURLが明確に示されるように改善されています。
これらの変更は、ユーザビリティの向上と、APIの使用法をより明確に説明するために重要です。また、情報を最新のものに保つことで、開発者が効果的にサービスを利用できるようにサポートしています。
articles/ai-studio/how-to/index-add.md
Diff
@@ -78,9 +78,8 @@ You must have:
1. Provide a name for your Index Lookup Tool and select **Add**.
1. Select the **mlindex_content** value box, and select your index from the value section. After completing this step, enter the queries and **query_types** to be performed against the index.
- :::image type="content" source="../media/index-retrieve/configure-index-lookup-tool.png" alt-text="Screenshot of the prompt flow node to configure index lookup." lightbox="../media/index-retrieve/configure-index-lookup-tool.png":::
+ :::image type="content" source="../media/index-retrieve/configure-index-lookup-tool.png" alt-text="Screenshot of the prompt flow node to configure index lookup." lightbox="../media/index-retrieve/configure-index-lookup-tool.png":::
- :::image type="content" source="../media/index-retrieve/generate-index.png" alt-text="Screenshot of the prompt flow node to generate an index." lightbox="../media/index-retrieve/generate-index.png":::
## Related content
Summary
{
"modification_type": "minor update",
"modification_title": "インデックス追加手順の画像リンク修正"
}
Explanation
この変更は、「index-add.md」ファイルの内容を軽微に修正したもので、主に画像リンクの調整が含まれています。以下の点が変更されました:
画像のリンク修正: 画像の2つのリンクが修正され、一貫性を持たせるために、lightboxのパラメータが統一されました。これにより、画像が直接表示される際の動作や見た目が一貫して管理されます。
不要な行の削除: 以前のバージョンで重複していた画像の行が削除され、ドキュメントが整理され効率的になりました。
これらの変更は、ドキュメントの可読性とメンテナンス性を向上させることを目的としており、ユーザーにとっての情報提供がさらに効果的になります。
articles/ai-studio/media/index-retrieve/configure-index-lookup-tool.png
Summary
{
"modification_type": "minor update",
"modification_title": "インデックスルックアップツールの画像更新"
}
Explanation
この変更は、configure-index-lookup-tool.png
という画像ファイルの更新に関連しています。具体的な変更内容は以下の通りです:
画像ファイルの更新: このコミットでは、configure-index-lookup-tool.png
ファイルが新しいバージョンに置き換えられましたが、具体的な内容やサイズに関する詳細は示されていないため、視覚的な改善点や変更がどのようなものであるかは確認できません。
ドキュメントとの関連性: この画像は、インデックスルックアップツールの設定に関する手順と連携しているため、適切に更新されることで、ユーザーが正確な情報を得ることができます。
この更新は、視覚的な要素を最新の情報に保つことで、ユーザー体験を向上させることを目的としています。
articles/ai-studio/media/index-retrieve/index-lookup-tool.png
Summary
{
"modification_type": "minor update",
"modification_title": "インデックスルックアップツール用画像の更新"
}
Explanation
この変更は、index-lookup-tool.png
という画像ファイルの更新に関するもので、具体的には以下の内容が含まれています:
画像ファイルの更新: このコミットでは、index-lookup-tool.png
ファイルが新しいバージョンに置き換えられました。具体的な変更点については詳細が記載されていないため、どのような視覚的改善や内容の変更が行われたかは不明です。
利用目的: この画像は、インデックスルックアップツールに関連する内容を示すものであり、適切に更新されることで、ユーザーがその使用方法や機能を理解しやすくなります。
この更新により、ドキュメントの視覚的要素が最新の状態に保たれ、情報の正確性が向上することが期待されます。