ビデオ検索 API リファレンス

重要

2025 年 6 月 30 日に、Azure AI Vision ビデオの取得は廃止されます。 この機能を廃止する決定は、ビデオ処理に提供される機能を改善および簡素化し、改善するための継続的な取り組みの一環です。 Azure AI Content Understanding と Azure AI Search に移行して、追加の機能を活用します。

ビデオ処理: ビデオの取得と Azure AI Content Understanding

特徴	ビデオの説明のビデオ取得	Azure AIコンテンツ理解
サポートされているビデオの長さ	短いビデオ用に最適化され、最大 3 分	4時間までの短い&長いビデオをサポート
フレーム処理	最大 20 フレーム	バッチ処理、ビデオ全体でサンプリングされたショットバイショットサンプリング
コンテンツ抽出の前処理	テープ起こし	文字起こし、ショット識別、顔のグループ化
構造化出力のサポート	サポートされていません	スキーマ準拠の構造化された出力をサポートします
データ型	サポートされているビデオ	サポートされているビデオ、画像、ドキュメント、音声
価格設定	変数トークンベース	処理されたビデオの 1 分あたりの固定コスト

ビデオの概要と説明のために Content Understanding に移行するには、 Azure AI Content Understanding のドキュメントを確認することをお勧めします。

ビデオ検索: ビデオの取得と Azure AI の検索とコンテンツの理解

特徴	ビデオ検索のビデオ取得	Azure AI Search と Content Understanding
Visual Embedding 型	フレームベースの画像埋め込み	ビデオの説明テキスト埋め込み
コンテンツ抽出の前処理	文字起こし、OCR	文字起こし、ショット識別、顔のグループ化
ユーザーとオブジェクト検索のサポート	強力なサポート	強力なサポート
アクションとイベントのサポート	狹	強力なサポート
カスタマイズ	無し	Content Understanding アナライザーは、フィールドとフィールドの説明を使用してフォーカスするようにカスタマイズできます

Content Understanding で検索ユース ケースの構築を開始するには、この サンプル から始めて、Azure AI Search を使用してビデオを検索する方法を示します。

サービスの中断を回避するには、2025 年 6 月 30 日までに移行します。

認証

このドキュメントの任意の API を呼び出すときに、次のヘッダーを含めます。

Ocp-Apim-Subscription-Key: YOUR_COMPUTER_VISION_KEY バージョン: 2023-05-01-preview

CreateIndex

URL

PUT /retrieval/indexes/{indexName}?api-version=<version_number>

説明

このメソッドは、ドキュメントの取り込みに使用できるインデックスを作成します。 取り込みを実行する前に、インデックスを作成する必要があります。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	作成するインデックスの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも
体	体	検索に使用できるメタデータを含む要求本文。	はい	CreateIngestionIndexRequestModel

応答

コード	説明	タイプ
201	作成	GetIngestionIndexResponseModel

インデックス取得

URL

GET /retrieval/indexes/{indexName}?api-version=<version_number>

説明

指定された名前でインデックスを取得します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	取得するインデックスの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも

応答

コード	説明	タイプ
200	成功	GetIngestionIndexResponseModel
デフォルト	エラー	ErrorResponse の

UpdateIndex

URL

PATCH /retrieval/indexes/{indexName}?api-version=<version_number>

説明

指定した名前でインデックスを更新します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	更新するインデックスの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも
体	体	インデックスに適用する更新を含む要求本文。	はい	UpdateIngestionIndexRequestModel

応答

コード	説明	タイプ
200	成功	GetIngestionIndexResponseModel
デフォルト	エラー	ErrorResponse の

DeleteIndex

URL

DELETE /retrieval/indexes/{indexName}?api-version=<version_number>

説明

インデックスとそれに関連付けられているすべてのインジェスト ドキュメントを削除します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	削除するインデックスの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも

応答

コード	説明
204	コンテンツなし

ListIndexes

URL

GET /retrieval/indexes?api-version=<version_number>

説明

すべてのインジェストのすべてのインデックスのリストを取得します。

パラメーター

名前	ロケーション	説明	必須	タイプ
$skip	問い合わせ	スキップするデータセットの数。	いいえ	整数 (integer)
$top	問い合わせ	スキップ後に返されるデータセットの数。	いいえ	整数 (integer)
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも

応答

コード	説明	タイプ
200	成功	GetIngestionIndexResponseModelCollectionApiModel
デフォルト	エラー	ErrorResponse の

CreateIngestion

URL

PUT /retrieval/indexes/{indexName}/ingestions/{ingestionName}?api-version=<version_number>

説明

インジェスト要求にはビデオ ペイロードを含めることができます。 これには、3 つのモード (追加、更新、削除) のいずれかを指定できます。 追加モードでは、インジェストが作成され、ビデオが処理されます。 更新モードでは、メタデータのみが更新されます。 ビデオを再処理するには、インジェストを削除して再作成する必要があります。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	インジェストの作成先となるインデックスの名前。	はい	ひも
ingestionName	道	作成するインジェストの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも
体	体	作成するインジェスト要求を含む要求本文。	はい	CreateIngestionRequestModel

応答

コード	説明	タイプ
202	受け入れられた	IngestionResponseModel

GetIngestion

URL

GET /retrieval/indexes/{indexName}/ingestions/{ingestionName}?api-version=<version_number>

説明

指定したインデックスとインジェスト名のインジェストの状態を取得します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	インジェストの状態を確認するインデックスの名前。	はい	ひも
ingestionName	道	取得するインジェストの名前。	はい	ひも
detailLevel	問い合わせ	ドキュメントのインジェストの状態ごとの詳細レベルを示すレベル。	いいえ	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも

応答

コード	説明	タイプ
200	成功	IngestionResponseModel
デフォルト	エラー	ErrorResponse の

ListIngestions

URL

GET /retrieval/indexes/{indexName}/ingestions?api-version=<version_number>

説明

特定のインデックスのすべてのインジェストを取得します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	インジェストを取得するインデックスの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも

応答

コード	説明	タイプ
200	成功	IngestionResponseModelCollectionApiModel
デフォルト	エラー	ErrorResponse の

ListDocuments

URL

GET /retrieval/indexes/{indexName}/documents?api-version=<version_number>

説明

特定のインデックスのすべてのドキュメントを取得します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	ドキュメントを取得するインデックスの名前。	はい	ひも
$skip	問い合わせ	スキップするデータセットの数。	いいえ	整数 (integer)
$top	問い合わせ	スキップ後に返されるデータセットの数。	いいえ	整数 (integer)
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも

応答

コード	説明	タイプ
200	成功	IngestionDocumentResponseModelCollectionApiModel
デフォルト	エラー	ErrorResponse の

SearchByText

URL

POST /retrieval/indexes/{indexName}:queryByText?api-version=<version_number>

説明

指定したインデックスに対してテキストベースの検索を実行します。

パラメーター

名前	ロケーション	説明	必須	タイプ
indexName	道	検索するインデックスの名前。	はい	ひも
APIバージョン	問い合わせ	要求された API バージョン。	はい	ひも
体	体	クエリとその他のパラメーターを含む要求本文。	はい	SearchQueryTextRequestModel

応答

コード	説明	タイプ
200	成功	SearchResultDocumentModelCollectionApiModel
デフォルト	エラー	ErrorResponse の

モデル

CreateIngestionIndexRequestModel

JSON ドキュメントのインジェスト インデックス作成要求モデルを表します。

名前	タイプ	説明	必須
metadataSchema	MetadataSchemaModel		いいえ
機能	[ FeatureModel ]	ドキュメントの機能のリストを取得または設定します。 既定値は "vision" です。	いいえ
userData	オブジェクト	ドキュメントのユーザー データを取得または設定します。	いいえ

CreateIngestionRequestModel

JSON ドキュメントのインジェスト作成要求モデルを表します。

名前	タイプ	説明	必須
ビデオ	[ IngestionDocumentRequestModel ]	JSON ドキュメント内のビデオ ドキュメント インジェスト要求のリストを取得または設定します。	いいえ
モデレート	ブーリアン	コンテンツをモデレートする必要があるかどうかを示すモデレーション フラグを取得または設定します。	いいえ
generateInsightIntervals	ブーリアン	分析情報の間隔を生成する必要があるかどうかを示す、間隔生成フラグを取得または設定します。	いいえ
documentAuthenticationKind	ひも	ドキュメントのダウンロードに使用する認証の種類を取得または設定します。 Enum:"none", "managedIdentity"	いいえ
filterDefectedFrames	ブーリアン	フレームが評価され、欠陥のあるすべてのフレーム (例: ぼやけ、低光量、露出超過) がフィルタリングされて除外されることを示すフレーム フィルター フラグ。	いいえ
includeSpeechTranscript	ブーリアン	トランスクリプトを生成する必要があるかを示す、トランスクリプト生成フラグを取得または設定します。	いいえ

DatetimeFilterModel

検索クエリに適用する datetime フィルターを表します。

名前	タイプ	説明	必須
fieldName	ひも	フィルター処理するフィールドの名前を取得または設定します。	はい
開始時間	ひも	フィルター処理する範囲の開始時刻を取得または設定します。	いいえ
endTime	ひも	フィルター処理する範囲の終了時刻を取得または設定します。	いいえ

エラー応答

エラーが発生したときに返される応答。

名前	タイプ	説明	必須
エラー	ErrorResponseDetails		はい

ErrorResponseDetails

エラー情報です。

名前	タイプ	説明	必須
コード	ひも	エラー コード。	はい
メッセージ	ひも	エラー メッセージ。	はい
ターゲット	ひも	エラーのターゲットです。	いいえ
詳細	[ ErrorResponseDetails ]	詳細なエラーのリストです。	いいえ
innererror	ErrorResponseInnerError		いいえ

ErrorResponseInnerError

エラーの詳細です。

名前	タイプ	説明	必須
コード	ひも	エラー コード。	はい
メッセージ	ひも	エラー メッセージ。	はい
innererror	ErrorResponseInnerError		いいえ

FeatureModel

インデックス内の機能を表します。

名前	タイプ	説明	必須
名前	ひも	機能の名前を取得または設定します。 Enum:"vision", "speech"	はい
modelVersion	ひも	機能のモデル バージョンを取得または設定します。	いいえ
ドメイン	ひも	機能のモデル ドメインを取得または設定します。 Enum:"generic", "surveillance"	いいえ

GetIngestionIndexResponseModel

JSON ドキュメントのインジェスト インデックス取得応答モデルを表します。

名前	タイプ	説明	必須
名前	ひも	インデックス名プロパティを取得または設定します。	いいえ
metadataSchema	MetadataSchemaModel		いいえ
userData	オブジェクト	ドキュメントのユーザー データを取得または設定します。	いいえ
機能	[ FeatureModel ]	インデックス内の機能リストを取得または設定します。	いいえ
eTag	ひも	etag を取得または設定します。	はい
createdDateTime	日時	作成日時のプロパティを取得または設定します。	はい
lastModifiedDateTime	日時	最終変更日時のプロパティを取得または設定します。	はい

GetIngestionIndexResponseModelCollectionApiModel

ページ分割される可能性がある結果の配列を格納します。

名前	タイプ	説明	必須
価値	[ GetIngestionIndexResponseModel ]	結果の配列。	はい
nextLink	ひも	使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。	いいえ

IngestionDocumentRequestModel

JSON ドキュメント内のビデオ ドキュメント インジェスト要求を表します。

名前	タイプ	説明	必須
モード	ひも	ドキュメントのインジェストのモードを取得または設定します。 Enum:"add"、 "update"、 "remove"	はい
documentId	ひも	ドキュメント ID を取得または設定します。	いいえ
documentUrl	string (URI)	ドキュメントの URL を取得または設定します。 Shared Access Signature (SAS) がある場合は、URL から削除されます。	はい
メタデータ	オブジェクト	名前と値の組のディクショナリとしてのドキュメントに関するメタデータを取得または設定します。	いいえ
userData	オブジェクト	ドキュメントのユーザー データを取得または設定します。	いいえ

IngestionDocumentResponseModel

JSON ドキュメント内のインジェスト ドキュメント応答オブジェクトを表します。

名前	タイプ	説明	必須
documentId	ひも	ドキュメント ID を取得または設定します。	いいえ
documentUrl	string (URI)	ドキュメントの URL を取得または設定します。 Shared Access Signature (SAS) がある場合は、URL から削除されます。	いいえ
メタデータ	オブジェクト	メタデータのキーと値のペアを取得または設定します。	いいえ
エラー	ErrorResponseDetails		いいえ
createdDateTime	日時	ドキュメントの作成日時を取得または設定します。	いいえ
lastModifiedDateTime	日時	ドキュメントの最終変更日時を取得または設定します。	いいえ
userData	オブジェクト	ドキュメントのユーザー データを取得または設定します。	いいえ

IngestionDocumentResponseModelCollectionApiModel

ページ分割される可能性がある結果の配列を格納します。

名前	タイプ	説明	必須
価値	[ IngestionDocumentResponseModel ]	結果の配列。	はい
nextLink	ひも	使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。	いいえ

IngestionErrorDetailsApiModel

各ドキュメントのインジェスト エラー情報を表します。

名前	タイプ	説明	必須
コード	ひも	エラー コード。	いいえ
メッセージ	ひも	エラー メッセージ。	いいえ
innerError	IngestionInnerErrorDetailsApiModel		いいえ

IngestionInnerErrorDetailsApiModel

各ドキュメントのインジェスト内部エラー情報を表します。

名前	タイプ	説明	必須
コード	ひも	エラー コード。	いいえ
メッセージ	ひも	エラー メッセージ。	いいえ
innerError	IngestionInnerErrorDetailsApiModel		いいえ

IngestionResponseModel

JSON ドキュメントのインジェスト応答モデルを表します。

名前	タイプ	説明	必須
名前	ひも	インジェストの名前を取得または設定します。	いいえ
状態	ひも	インジェストの状態を取得または設定します。 Enum:"notStarted"、 "running"、 "completed"、 "failed"、 "partiallySucceeded"	いいえ
エラー	ErrorResponseDetails		いいえ
batchName	ひも	このインジェストに関連付けられているバッチの名前。	いいえ
createdDateTime	日時	インジェストの作成日時を取得または設定します。	いいえ
lastModifiedDateTime	日時	インジェストの最終変更日時を取得または設定します。	いいえ
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	各ドキュメントのインジェストの状態のリスト。	いいえ

IngestionResponseModelCollectionApiModel

ページ分割される可能性がある結果の配列を格納します。

名前	タイプ	説明	必須
価値	[ IngestionResponseModel ]	結果の配列。	はい
nextLink	ひも	使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。	いいえ

IngestionStatusDetailsApiModel

各ドキュメントのインジェストの状態の詳細を表します。

名前	タイプ	説明	必須
lastUpdateTime	日時	バッチ チャンクの状態更新時刻。	はい
documentId	ひも	ドキュメント ID。	はい
documentUrl	string (URI)	ドキュメントの URL。	いいえ
成功した	ブーリアン	推論が成功したかどうかを示すフラグ。	はい
エラー	IngestionErrorDetailsApiModel		いいえ

MetadataSchemaFieldModel

メタデータ スキーマ内のフィールドを表します。

名前	タイプ	説明	必須
名前	ひも	フィールドの名前を取得または設定します。	はい
検索	ブーリアン	フィールドが検索可能かどうかを示す値を取得または設定します。	はい
濾過	ブーリアン	フィールドがフィルター可能かどうかを示す値を取得または設定します。	はい
種類	ひも	フィールドの型を取得または設定します。 文字列または datetime を指定できます。 Enum:"string", "datetime"	はい

MetadataSchemaModel

ドキュメントのメタデータ スキーマを表します。

名前	タイプ	説明	必須
言語	ひも	メタデータ スキーマの言語を取得または設定します。 既定値は "en" です。	いいえ
田畑	[ MetadataSchemaFieldModel ]	メタデータ スキーマ内のフィールドのリストを取得または設定します。	はい

SearchFiltersModel

検索クエリに適用するフィルターを表します。

名前	タイプ	説明	必須
stringFilters	[ StringFilterModel ]	検索クエリに適用する文字列フィルターを取得または設定します。	いいえ
datetimeFilters	[ DatetimeFilterModel ]	検索クエリに適用する datetime フィルターを取得または設定します。	いいえ
featureFilters	[ string ]	検索クエリに適用する機能フィルターを取得または設定します。	いいえ

SearchQueryTextRequestModel

テキストベースの検索の検索クエリ要求モデルを表します。

名前	タイプ	説明	必須
queryText	ひも	クエリ テキストを取得または設定します。	はい
フィルター	SearchFiltersModel		いいえ
モデレート	ブーリアン	モデレーションが有効か無効かを示すブール値を取得または設定します。	いいえ
上位	整数 (integer)	取得する結果の数を取得または設定します。	はい
スキップ	整数 (integer)	スキップする結果の数を取得または設定します。	はい
additionalIndexNames	[ string ]	検索クエリに含める追加のインデックス名を取得または設定します。	いいえ
重複除去	ブーリアン	同様のビデオ フレームを削除するかどうか。	はい
dedupMaxDocumentCount	整数 (integer)	重複除去後のドキュメントの最大数。	はい
disableMetadataSearch	ブーリアン	検索でメタデータが無効かどうかを示すブール値を取得または設定します。	はい

SearchResultDocumentModel

検索クエリの応答を表します。

名前	タイプ	説明	必須
documentId	ひも	ドキュメントの ID を取得または設定します。	いいえ
documentKind	ひも	ドキュメントの種類を取得または設定します。"video" にすることができます。	いいえ
始める	ひも	ドキュメントの開始時刻を取得または設定します。 このプロパティは、ビデオ ドキュメントにのみ適用されます。	いいえ
終了	ひも	ドキュメントの終了時刻を取得または設定します。 このプロパティは、ビデオ ドキュメントにのみ適用されます。	いいえ
テスト	ひも	関連性スコアが最も高いドキュメントのタイムスタンプを取得または設定します。 このプロパティは、ビデオ ドキュメントにのみ適用されます。	いいえ
関連性	倍精度浮動小数点	ドキュメントの関連性スコアを取得または設定します。	はい
additionalMetadata	オブジェクト	検索に関連する追加のメタデータを取得または設定します。	いいえ

SearchResultDocumentModelCollectionApiModel

ページ分割される可能性がある結果の配列を格納します。

名前	タイプ	説明	必須
価値	[ SearchResultDocumentModel ]	結果の配列。	はい
nextLink	ひも	使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。	いいえ

StringFilterModel

検索クエリに適用する文字列フィルターを表します。

名前	タイプ	説明	必須
fieldName	ひも	フィルター処理するフィールドの名前を取得または設定します。	はい
値	[ string ]	フィルター処理する値を取得または設定します。	はい

UpdateIngestionIndexRequestModel

JSON ドキュメントのインジェスト インデックス更新要求モデルを表します。

名前	タイプ	説明	必須
metadataSchema	MetadataSchemaModel		いいえ
userData	オブジェクト	ドキュメントのユーザー データを取得または設定します。	いいえ