次の方法で共有

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

  • [アーティクル]

認証

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

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

CreateIndex

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path 作成するインデックスの名前。 はい string
api-version query 要求された API バージョン。 はい string
body body 検索に使用できるメタデータを含む要求本文。 はい CreateIngestionIndexRequestModel

応答

コード Description Type
201 作成 GetIngestionIndexResponseModel

GetIndex

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path 取得するインデックスの名前。 はい string
api-version query 要求された API バージョン。 はい string

応答

コード Description Type
200 Success GetIngestionIndexResponseModel
default Error ErrorResponse

UpdateIndex

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path 更新するインデックスの名前。 はい string
api-version query 要求された API バージョン。 はい string
body body インデックスに適用する更新を含む要求本文。 はい UpdateIngestionIndexRequestModel

応答

コード Description Type
200 Success GetIngestionIndexResponseModel
default Error ErrorResponse

DeleteIndex

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path 削除するインデックスの名前。 はい string
api-version query 要求された API バージョン。 はい string

応答

コード 説明
204 No Content

ListIndexes

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
$skip query スキップするデータセットの数。 いいえ integer
$top query スキップ後に返されるデータセットの数。 いいえ integer
api-version query 要求された API バージョン。 はい string

応答

コード Description Type
200 Success GetIngestionIndexResponseModelCollectionApiModel
default Error ErrorResponse

CreateIngestion

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path インジェストの作成先となるインデックスの名前。 はい string
ingestionName path 作成するインジェストの名前。 はい string
api-version query 要求された API バージョン。 はい string
body body 作成するインジェスト要求を含む要求本文。 はい CreateIngestionRequestModel

応答

コード Description Type
202 Accepted IngestionResponseModel

GetIngestion

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path インジェストの状態を確認するインデックスの名前。 はい string
ingestionName path 取得するインジェストの名前。 はい string
detailLevel query ドキュメントのインジェストの状態ごとの詳細レベルを示すレベル。 いいえ string
api-version query 要求された API バージョン。 はい string

応答

コード Description Type
200 Success IngestionResponseModel
default Error ErrorResponse

ListIngestions

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path インジェストを取得するインデックスの名前。 はい string
api-version query 要求された API バージョン。 はい string

応答

コード Description Type
200 Success IngestionResponseModelCollectionApiModel
default Error ErrorResponse

ListDocuments

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path ドキュメントを取得するインデックスの名前。 はい string
$skip query スキップするデータセットの数。 いいえ integer
$top query スキップ後に返されるデータセットの数。 いいえ integer
api-version query 要求された API バージョン。 はい string

応答

コード Description Type
200 Success IngestionDocumentResponseModelCollectionApiModel
default Error ErrorResponse

SearchByText

URL

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

説明

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

パラメーター

名前 ロケーション 説明 必須 Type
indexName path 検索するインデックスの名前。 はい string
api-version query 要求された API バージョン。 はい string
body body クエリとその他のパラメーターを含む要求本文。 はい SearchQueryTextRequestModel

応答

コード Description Type
200 Success SearchResultDocumentModelCollectionApiModel
default Error ErrorResponse

モデル

CreateIngestionIndexRequestModel

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

名前 種類 内容 必須
metadataSchema MetadataSchemaModel いいえ
features [ FeatureModel ] ドキュメントの機能のリストを取得または設定します。 既定値は "vision" です。 いいえ
userData object ドキュメントのユーザー データを取得または設定します。 いいえ

CreateIngestionRequestModel

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

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

DatetimeFilterModel

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

名前 種類 内容 必須
fieldName string フィルター処理するフィールドの名前を取得または設定します。 はい
startTime string フィルター処理する範囲の開始時刻を取得または設定します。 いいえ
endTime string フィルター処理する範囲の終了時刻を取得または設定します。 いいえ

ErrorResponse

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

名前 種類 内容 必須
エラー ErrorResponseDetails はい

ErrorResponseDetails

エラー情報です。

名前 種類 内容 必須
コード string エラー コード。 はい
message string エラー メッセージ。 はい
ターゲット string エラーのターゲットです。 いいえ
詳細 [ ErrorResponseDetails ] 詳細なエラーのリストです。 いいえ
innererror ErrorResponseInnerError いいえ

ErrorResponseInnerError

エラーの詳細です。

名前 種類 内容 必須
コード string エラー コード。 はい
message string エラー メッセージ。 はい
innererror ErrorResponseInnerError いいえ

FeatureModel

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

名前 種類 内容 必須
name string 機能の名前を取得または設定します。
Enum: "vision", "speech" 		はい
modelVersion string 機能のモデル バージョンを取得または設定します。 いいえ
ドメイン string 機能のモデル ドメインを取得または設定します。
Enum: "generic", "surveillance" 		いいえ

GetIngestionIndexResponseModel

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

名前 種類 内容 必須
name string インデックス名プロパティを取得または設定します。 いいえ
metadataSchema MetadataSchemaModel いいえ
userData object ドキュメントのユーザー データを取得または設定します。 いいえ
features [ FeatureModel ] インデックス内の機能リストを取得または設定します。 いいえ
eTag string etag を取得または設定します。 はい
createdDateTime dateTime 作成日時のプロパティを取得または設定します。 はい
lastModifiedDateTime dateTime 最終変更日時のプロパティを取得または設定します。 はい

GetIngestionIndexResponseModelCollectionApiModel

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

名前 種類 内容 必須
value [ GetIngestionIndexResponseModel ] 結果の配列。 はい
nextLink string 使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。 いいえ

IngestionDocumentRequestModel

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

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

IngestionDocumentResponseModel

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

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

IngestionDocumentResponseModelCollectionApiModel

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

名前 種類 内容 必須
value [ IngestionDocumentResponseModel ] 結果の配列。 はい
nextLink string 使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。 いいえ

IngestionErrorDetailsApiModel

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

名前 種類 内容 必須
コード string エラー コード。 いいえ
message string エラー メッセージ。 いいえ
innerError IngestionInnerErrorDetailsApiModel いいえ

IngestionInnerErrorDetailsApiModel

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

名前 種類 内容 必須
コード string エラー コード。 いいえ
message string エラー メッセージ。 いいえ
innerError IngestionInnerErrorDetailsApiModel いいえ

IngestionResponseModel

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

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

IngestionResponseModelCollectionApiModel

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

名前 種類 内容 必須
value [ IngestionResponseModel ] 結果の配列。 はい
nextLink string 使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。 いいえ

IngestionStatusDetailsApiModel

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

名前 種類 内容 必須
lastUpdateTime dateTime バッチ チャンクの状態更新時刻。 はい
documentId string ドキュメント ID。 はい
documentUrl string (URI) ドキュメントの URL。 いいえ
succeeded boolean 推論が成功したかどうかを示すフラグ。 はい
エラー IngestionErrorDetailsApiModel いいえ

MetadataSchemaFieldModel

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

名前 種類 内容 必須
name string フィールドの名前を取得または設定します。 はい
searchable boolean フィールドが検索可能かどうかを示す値を取得または設定します。 はい
filterable boolean フィールドがフィルター可能かどうかを示す値を取得または設定します。 はい
type string フィールドの型を取得または設定します。 文字列または datetime を指定できます。
Enum: "string", "datetime" 		はい

MetadataSchemaModel

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

名前 種類 内容 必須
言語 string メタデータ スキーマの言語を取得または設定します。 既定値は "en" です。 いいえ
fields [ MetadataSchemaFieldModel ] メタデータ スキーマ内のフィールドのリストを取得または設定します。 はい

SearchFiltersModel

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

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

SearchQueryTextRequestModel

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

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

SearchResultDocumentModel

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

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

SearchResultDocumentModelCollectionApiModel

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

名前 種類 内容 必須
value [ SearchResultDocumentModel ] 結果の配列。 はい
nextLink string 使用可能な結果が他にある場合は、ページ分割された結果の次のセットへのリンク。ない場合は存在しません。 いいえ

StringFilterModel

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

名前 種類 内容 必須
fieldName string フィルター処理するフィールドの名前を取得または設定します。 はい
値 [ string ] フィルター処理する値を取得または設定します。 はい

UpdateIngestionIndexRequestModel

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

名前 種類 内容 必須
metadataSchema MetadataSchemaModel いいえ
userData object ドキュメントのユーザー データを取得または設定します。 いいえ