Skip to content

Commit 3efd32b

Browse files
author
Jill Grant
authored
Merge pull request #255492 from PatrickFarley/comvis-updates
Comvis updates
2 parents 6611c21 + 1ca5efe commit 3efd32b

File tree

2 files changed

+27
-14
lines changed

2 files changed

+27
-14
lines changed

articles/ai-services/computer-vision/how-to/video-retrieval.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,34 @@ Azure AI Spatial Analysis Video Retrieval APIs are part of Azure AI Vision and e
2525

2626
## Input requirements
2727

28-
### Supported file formats
28+
### Supported formats
29+
2930
| File format | Description |
3031
| ----------- | ----------- |
3132
| `asf` | ASF (Advanced / Active Streaming Format) |
33+
| `avi` | AVI (Audio Video Interleaved) |
3234
| `flv` | FLV (Flash Video) |
3335
| `matroskamm`, `webm` | Matroska / WebM |
34-
| `mov`, `mp4`, `m4a`, `3gp`, `3g2`, `mj2` | QuickTime / MOV |
35-
| `mpegts` | MPEG-TS (MPEG-2 Transport Stream) |
36-
| `rawvideo` | raw video |
37-
| `rm` | RealMedia |
38-
| `rtsp` | RTSP input |
36+
| `mov`,`mp4`,`m4a`,`3gp`,`3g2`,`mj2` | QuickTime / MOV |
37+
38+
### Supported video codecs
3939

40-
### Supported codecs
4140
| Codec | Format |
4241
| ----------- | ----------- |
4342
| `h264` | H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 |
44-
| `rawvideo` | raw video |
45-
| `h265` | HEVC
43+
| `h265` | H.265/HEVC |
4644
| `libvpx-vp9` | libvpx VP9 (codec vp9) |
45+
| `mpeg4` | MPEG-4 part 2 |
46+
47+
### Supported audio codecs
48+
49+
| Codec | Format |
50+
| ----------- | ----------- |
51+
| `aac` | AAC (Advanced Audio Coding) |
52+
| `mp3` | MP3 (MPEG audio layer 3) |
53+
| `pcm` | PCM (uncompressed) |
54+
| `vorbis` | Vorbis |
55+
| `wmav2` | Windows Media Audio 2 |
4756

4857
## Call the Video Retrieval APIs
4958

@@ -61,7 +70,7 @@ The Spatial Analysis Video Retrieval APIs allows a user to add metadata to video
6170

6271
### Step 1: Create an Index
6372

64-
To begin, you need to create an index to store and organize the video files and their metadata. The example below demonstrates how to create an index named "my-video-index."
73+
To begin, you need to create an index to store and organize the video files and their metadata. The example below demonstrates how to create an index named "my-video-index" using the **[Create Index](https://eastus.dev.cognitive.microsoft.com/docs/services/ingestion-api-private-preview-2023-05-01-preview/operations/645db36646346106fcc4779b)** API.
6574

6675
```bash
6776
curl.exe -v -X PUT "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexes/my-video-index?api-version=2023-05-01-preview" -H "Ocp-Apim-Subscription-Key: <YOUR_SUBSCRIPTION_KEY>" -H "Content-Type: application/json" --data-ascii "
@@ -145,7 +154,7 @@ Connection: close
145154

146155
### Step 2: Add video files to the index
147156

148-
Next, you can add video files to the index with their associated metadata. The example below demonstrates how to add two video files to the index using SAS URLs to provide access.
157+
Next, you can add video files to the index with their associated metadata. The example below demonstrates how to add two video files to the index using SAS URLs with the **[Create Ingestion](https://eastus.dev.cognitive.microsoft.com/docs/services/ingestion-api-private-preview-2023-05-01-preview/operations/645db36646346106fcc4779f)** API.
149158

150159

151160
```bash
@@ -195,7 +204,7 @@ Connection: close
195204

196205
### Step 3: Wait for ingestion to complete
197206

198-
After you add video files to the index, the ingestion process starts. It might take some time depending on the size and number of files. To ensure the ingestion is complete before performing searches, you can use the **Get Ingestion** call to check the status. Wait for this call to return `"state" = "Completed"` before proceeding to the next step.
207+
After you add video files to the index, the ingestion process starts. It might take some time depending on the size and number of files. To ensure the ingestion is complete before performing searches, you can use the **[Get Ingestion](https://eastus.dev.cognitive.microsoft.com/docs/services/ingestion-api-private-preview-2023-05-01-preview/operations/645db36646346106fcc477a0)** API to check the status. Wait for this call to return `"state" = "Completed"` before proceeding to the next step.
199208

200209
```bash
201210
curl.exe -v _X GET "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexes/my-video-index/ingestions?api-version=2023-05-01-preview&$top=20" -H "ocp-apim-subscription-key: <YOUR_SUBSCRIPTION_KEY>"
@@ -230,7 +239,7 @@ After you add video files to the index, you can search for specific videos using
230239

231240
#### Search with "vision" feature
232241

233-
To perform a search using the "vision" feature, specify the query text and any desired filters.
242+
To perform a search using the "vision" feature, use the [Search By Text](https://eastus.dev.cognitive.microsoft.com/docs/services/ingestion-api-private-preview-2023-05-01-preview/operations/645db36646346106fcc477a2) API with the `vision` filter, specifying the query text and any other desired filters.
234243

235244
```bash
236245
POST -v -X "https://<YOUR_ENDPOINT_URL>/computervision/retrieval/indexes/my-video-index:queryByText?api-version=2023-05-01-preview" -H "Ocp-Apim-Subscription-Key: <YOUR_SUBSCRIPTION_KEY>" -H "Content-Type: application/json" --data-ascii "
@@ -293,7 +302,7 @@ Connection: close
293302

294303
#### Search with "speech" feature
295304

296-
To perform a search using the "speech" feature, provide the query text and any desired filters.
305+
To perform a search using the "speech" feature, use the **[Search By Text](https://eastus.dev.cognitive.microsoft.com/docs/services/ingestion-api-private-preview-2023-05-01-preview/operations/645db36646346106fcc477a2)** API with the `speech` filter, providing the query text and any other desired filters.
297306

298307
```bash
299308
curl.exe -v -X POST "https://<YOUR_ENDPOINT_URL>com/computervision/retrieval/indexes/my-video-index:queryByText?api-version=2023-05-01-preview" -H "Ocp-Apim-Subscription-Key: <YOUR_SUBSCRIPTION_KEY>" -H "Content-Type: application/json" --data-ascii "

articles/ai-services/computer-vision/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -396,6 +396,10 @@ items:
396396
href: spatial-analysis-camera-placement.md
397397
- name: All Azure AI containers
398398
href: ../cognitive-services-container-support.md?context=%2fazure%2fai-services%2fcomputer-vision%2fcontext%2fcontext
399+
- name: Reference
400+
items:
401+
- name: Video Retrieval REST API
402+
href: https://eastus.dev.cognitive.microsoft.com/docs/services/ingestion-api-private-preview-2023-05-01-preview/operations/645db36646346106fcc4779b
399403
- name: How-to guides
400404
items:
401405
- name: Enterprise readiness

0 commit comments

Comments
 (0)