|
1 | 1 | ---
|
2 | 2 | title: Do video retrieval using vectorization - Image Analysis 4.0
|
3 | 3 | titleSuffix: Azure AI services
|
4 |
| -description: Learn how to call the Video Retrieval APIs to vectorize video frames and search terms. |
| 4 | +description: Learn how to use the Video Retrieval APIs to vectorize video frames and search terms, and perform searches using metadata and features. |
5 | 5 | #services: cognitive-services
|
| 6 | +#customer intent: As a developer, I want to use Video Retrieval APIs to enhance video search capabilities with metadata and features. |
6 | 7 | author: PatrickFarley
|
7 | 8 | manager: nitinme
|
8 | 9 |
|
9 | 10 | ms.service: azure-ai-vision
|
10 | 11 | ms.topic: how-to
|
11 |
| -ms.date: 10/16/2023 |
| 12 | +ms.date: 01/22/2025 |
12 | 13 | ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
|
13 | 14 | ms.author: pafarley
|
14 | 15 | ---
|
15 | 16 |
|
16 | 17 | # Do video retrieval using vectorization (version 4.0 preview)
|
17 | 18 |
|
18 |
| -Azure AI Video Retrieval APIs are part of Azure AI Vision and enable developers to create an index, add documents (videos and images) to it, and search with natural language. Developers can define metadata schemas for each index and ingest metadata to the service to help with retrieval. Developers can also specify what features to extract from the index (vision, speech) and filter their search based on features. |
| 19 | +Azure AI Video Retrieval APIs are part of Azure AI Vision and enable developers to create a media index, add documents (videos and images) to it, and search it with natural language. Developers can define metadata schemas for each index and ingest metadata to the service to help with retrieval. Developers can also specify which features to extract from the index (vision, speech) and filter their search based on features. |
19 | 20 |
|
20 | 21 | ## Prerequisites
|
21 | 22 |
|
22 | 23 | - Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
|
23 | 24 | - Once you have your Azure subscription, [create a Vision resource using the portal](/azure/cognitive-services/cognitive-services-apis-create-account). For this preview, you must create your resource in the one of the following regions - Australia East, Switzerland North, Sweden Central, or East US.
|
24 | 25 | - An Azure Storage resource - [Create one](/azure/storage/common/storage-account-create?tabs=azure-portal)
|
25 | 26 |
|
26 |
| -## Input requirements |
| 27 | +## Select a video |
| 28 | + |
| 29 | +Refer to the video input requirements: |
27 | 30 |
|
28 | 31 | [!INCLUDE [video-retrieval-input](../includes/video-retrieval-input.md)]
|
29 | 32 |
|
30 | 33 | ## Call the Video Retrieval APIs
|
31 | 34 |
|
32 |
| -To use the Video Retrieval APIs in a typical pattern, you would do the following steps: |
| 35 | +To use the Video Retrieval APIs in a typical pattern, you'll follow these steps: |
33 | 36 |
|
34 | 37 | 1. Create an index using **PUT - Create an index**.
|
35 | 38 | 2. Add video documents to the index using **PUT - CreateIngestion**.
|
36 | 39 | 3. Wait for the ingestion to complete, checking with **GET - ListIngestions**.
|
37 | 40 | 4. Search for a keyword or phrase using **POST - SearchByText**.
|
38 | 41 |
|
39 | 42 |
|
40 |
| -### Use Video Retrieval APIs for metadata-based search |
| 43 | +### Example: Use Video Retrieval APIs for metadata-based search |
41 | 44 |
|
42 |
| -The Video Retrieval APIs allows a user to add metadata to video files. Metadata is additional information associated with video files such as "Camera ID," "Timestamp," or "Location" that can be used to organize, filter, and search for specific videos. This example demonstrates how to create an index, add video files with associated metadata, and perform searches using different features. |
| 45 | +The Video Retrieval APIs allow a user to add metadata to video files. Metadata is additional information associated with video files such as "Camera ID," "Timestamp," or "Location" that can be used to organize, filter, and search for specific videos. This example demonstrates how to create an index, add video files with associated metadata, and perform searches using different features. |
43 | 46 |
|
44 | 47 | ### Step 1: Create an Index
|
45 | 48 |
|
@@ -77,7 +80,7 @@ curl.exe -v -X PUT "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexes
|
77 | 80 | ```
|
78 | 81 |
|
79 | 82 | **Response:**
|
80 |
| -``` |
| 83 | +```console |
81 | 84 | HTTP/1.1 201 Created
|
82 | 85 | Content-Length: 530
|
83 | 86 | Content-Type: application/json; charset=utf-8
|
@@ -156,7 +159,7 @@ curl.exe -v -X PUT "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexes
|
156 | 159 | ```
|
157 | 160 |
|
158 | 161 | **Response:**
|
159 |
| -``` |
| 162 | +```console |
160 | 163 | HTTP/1.1 202 Accepted
|
161 | 164 | Content-Length: 152
|
162 | 165 | Content-Type: application/json; charset=utf-8
|
@@ -184,7 +187,7 @@ curl.exe -v -X GET "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexes
|
184 | 187 | ```
|
185 | 188 |
|
186 | 189 | **Response:**
|
187 |
| -``` |
| 190 | +```console |
188 | 191 | HTTP/1.1 200 OK
|
189 | 192 | Content-Length: 164
|
190 | 193 | Content-Type: application/json; charset=utf-8
|
@@ -233,7 +236,7 @@ curl.exe -v -X POST "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexe
|
233 | 236 | ```
|
234 | 237 |
|
235 | 238 | **Response:**
|
236 |
| -``` |
| 239 | +```console |
237 | 240 | HTTP/1.1 200 OK
|
238 | 241 | Content-Length: 3289
|
239 | 242 | Content-Type: application/json; charset=utf-8
|
@@ -297,7 +300,7 @@ curl.exe -v -X POST "https://<YOUR_ENDPOINT_URL>com/computervision/retrieval/ind
|
297 | 300 | ```
|
298 | 301 |
|
299 | 302 | **Response:**
|
300 |
| -``` |
| 303 | +```console |
301 | 304 | HTTP/1.1 200 OK
|
302 | 305 | Content-Length: 49001
|
303 | 306 | Content-Type: application/json; charset=utf-8
|
@@ -337,6 +340,7 @@ Connection: close
|
337 | 340 | }
|
338 | 341 | ```
|
339 | 342 |
|
340 |
| -## Next steps |
| 343 | +## Next step |
341 | 344 |
|
342 |
| -[Multimodal embeddings concepts](../concept-image-retrieval.md) |
| 345 | +> [!div class="nextstepaction"] |
| 346 | +> [Multimodal embeddings concepts](../concept-image-retrieval.md) |
0 commit comments