비디오 검색 API 참조

인증

이 문서에서 API를 호출할 때 다음 헤더를 포함합니다.

Ocp-Apim-Subscription-Key: 버전: YOUR_COMPUTER_VISION_KEY2023-05-01-preview

CreateIndex

URL

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

설명

이 메서드는 문서를 수집하는 데 사용할 수 있는 인덱스를 만듭니다. 수집을 수행하기 전에 인덱스가 만들어져야 합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	만들 인덱스의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string
본문	본문	검색에 사용할 수 있는 메타데이터가 포함된 요청 본문입니다.	예	CreateIngestionIndexRequestModel

응답

코드	Description	Type
201	Created	GetIngestionIndexResponseModel

GetIndex

URL

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

설명

지정된 이름의 인덱스를 검색합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	검색할 인덱스의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string

응답

코드	Description	Type
200	Success	GetIngestionIndexResponseModel
default	오류	ErrorResponse

UpdateIndex

URL

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

설명

지정된 이름으로 인덱스를 업데이트합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	업데이트할 인덱스의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string
본문	본문	인덱스에 적용할 업데이트를 포함하는 요청 본문입니다.	예	UpdateIngestionIndexRequestModel

응답

코드	Description	Type
200	Success	GetIngestionIndexResponseModel
default	오류	ErrorResponse

DeleteIndex

URL

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

설명

인덱스 및 관련된 모든 수집 문서를 삭제합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	삭제할 인덱스의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string

응답

코드	설명
204	No Content

ListIndexes

URL

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

설명

모든 수집에서 모든 인덱스 목록을 검색합니다.

매개 변수

속성	위치	설명	필수	Type
$skip	query	건너뛸 데이터 세트의 수입니다.	아니요	정수
$top	query	건너뛴 후 반환할 데이터 세트의 수입니다.	아니요	정수
api-version	query	요청된 API 버전입니다.	예	string

응답

코드	Description	Type
200	Success	GetIngestionIndexResponseModelCollectionApiModel
default	오류	ErrorResponse

CreateIngestion

URL

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

설명

수집 요청에는 비디오 페이로드가 있을 수 있습니다. 세 가지 모드(추가, 업데이트 또는 제거) 중 하나를 사용할 수 있습니다. 추가 모드는 수집을 만들고 비디오를 처리합니다. 업데이트 모드는 메타데이터만 업데이트합니다. 비디오를 다시 처리하려면 수집을 삭제하고 다시 만들어야 합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	수집이 생성될 인덱스의 이름입니다.	예	string
ingestionName	경로	만들 수집의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string
본문	본문	만들 수집 요청을 포함하는 요청 본문입니다.	예	CreateIngestionRequestModel

응답

코드	Description	Type
202	Accepted	IngestionResponseModel

GetIngestion

URL

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

설명

지정된 인덱스 및 수집 이름의 수집 상태를 가져옵니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	수집 상태를 확인할 인덱스의 이름입니다.	예	string
ingestionName	경로	검색할 수집의 이름입니다.	예	string
detailLevel	query	문서 수집 상태별 세부 수준을 나타내는 수준입니다.	아니요	string
api-version	query	요청된 API 버전입니다.	예	string

응답

코드	Description	Type
200	Success	IngestionResponseModel
default	오류	ErrorResponse

ListIngestions

URL

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

설명

특정 인덱스에 대한 모든 수집을 검색합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	수집을 검색할 인덱스의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string

응답

코드	Description	Type
200	Success	IngestionResponseModelCollectionApiModel
default	오류	ErrorResponse

ListDocuments

URL

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

설명

특정 인덱스에 대한 모든 문서를 검색합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	문서를 검색할 인덱스의 이름입니다.	예	string
$skip	query	건너뛸 데이터 세트의 수입니다.	아니요	정수
$top	query	건너뛴 후 반환할 데이터 세트의 수입니다.	아니요	정수
api-version	query	요청된 API 버전입니다.	예	string

응답

코드	Description	Type
200	Success	IngestionDocumentResponseModelCollectionApiModel
default	오류	ErrorResponse

SearchByText

URL

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

설명

지정된 인덱스에 대한 텍스트 기반 검색을 수행합니다.

매개 변수

속성	위치	설명	필수	Type
indexName	경로	검색할 인덱스의 이름입니다.	예	string
api-version	query	요청된 API 버전입니다.	예	string
본문	본문	쿼리 및 기타 매개 변수를 포함하는 요청 본문입니다.	예	SearchQueryTextRequestModel

응답

코드	Description	Type
200	Success	SearchResultDocumentModelCollectionApiModel
default	오류	ErrorResponse

모델

CreateIngestionIndexRequestModel

JSON 문서에 대한 수집 인덱스 만들기 요청 모델을 나타냅니다.

이름	형식	설명	필수
metadataSchema	MetadataSchemaModel		아니요
features	[ FeatureModel ]	문서의 기능 목록을 가져오거나 설정합니다. 기본값은 "vision"입니다.	아니요
UserData	개체	문서에 대한 사용자 데이터를 가져오거나 설정합니다.	아니요

CreateIngestionRequestModel

JSON 문서에 대한 수집 요청 만들기 모델을 나타냅니다.

이름	형식	설명	필수
videos	[ IngestionDocumentRequestModel ]	JSON 문서의 비디오 문서 수집 요청 목록을 가져오거나 설정합니다.	아니요
조정	부울 값	콘텐츠를 조정해야 하는지 여부를 나타내는 조정 플래그를 가져오거나 설정합니다.	아니요
generateInsightIntervals	부울 값	인사이트 간격을 생성해야 하는지 여부를 나타내는 간격 생성 플래그를 가져오거나 설정합니다.	아니요
documentAuthenticationKind	string	문서를 다운로드하는 데 사용할 인증 종류를 가져오거나 설정합니다. 열거형: "none", "managedIdentity"	아니요
filterDefectedFrames	부울 값	프레임을 나타내는 프레임 필터 플래그가 평가되고 결함(예: 흐릿함, 저조도, 과다 노출)이 있는 모든 프레임이 필터링됩니다.	아니요
includeSpeechTranscript	부울 값	음성 텍스트 생성 여부를 나타내는 음성 텍스트 생성 플래그를 가져오거나 설정합니다.	아니요

DatetimeFilterModel

검색 쿼리에 적용할 날짜/시간 필터를 나타냅니다.

이름	형식	설명	필수
fieldName	string	필터링할 필드의 이름을 가져오거나 설정합니다.	예
startTime	string	필터링할 범위의 시작 시간을 가져오거나 설정합니다.	아니요
endTime 사이에서	string	필터링할 범위의 종료 시간을 가져오거나 설정합니다.	아니요

ErrorResponse

오류가 발생할 때 응답이 반환됩니다.

이름	형식	설명	필수
error	ErrorResponseDetails		예

ErrorResponseDetails

오류 정보입니다.

이름	형식	설명	필수
코드	string	오류 코드	예
message	string	오류 메시지입니다.	예
target	string	오류의 대상입니다.	아니요
details	[ ErrorResponseDetails ]	자세한 오류 목록입니다.	아니요
innererror	ErrorResponseInnerError		아니요

ErrorResponseInnerError

자세한 오류입니다.

이름	형식	설명	필수
코드	string	오류 코드	예
message	string	오류 메시지입니다.	예
innererror	ErrorResponseInnerError		아니요

FeatureModel

인덱스의 기능을 나타냅니다.

이름	형식	설명	필수
name	string	기능의 이름을 가져오거나 설정합니다. 열거형: "vision", "speech"	예
모델 버전	string	기능의 모델 버전을 가져오거나 설정합니다.	아니요
도메인	string	기능의 모델 도메인을 가져오거나 설정합니다. 열거형: "generic", "surveillance"	아니요

GetIngestionIndexResponseModel

JSON 문서에 대한 수집 인덱스 가져오기 응답 모델을 나타냅니다.

이름	형식	설명	필수
name	string	인덱스 이름 속성을 가져오거나 설정합니다.	아니요
metadataSchema	MetadataSchemaModel		아니요
UserData	개체	문서에 대한 사용자 데이터를 가져오거나 설정합니다.	아니요
features	[ FeatureModel ]	인덱스의 기능 목록을 가져오거나 설정합니다.	아니요
eTag	string	etag를 가져오거나 설정합니다.	예
createdDateTime	dateTime	만든 날짜 및 시간 속성을 가져오거나 설정합니다.	예
lastModifiedDateTime	dateTime	마지막으로 수정한 날짜 및 시간 속성을 가져오거나 설정합니다.	예

GetIngestionIndexResponseModelCollectionApiModel

페이지를 매길 수 있는 결과 배열을 포함합니다.

이름	형식	설명	필수
value	[ GetIngestionIndexResponseModel ]	결과의 배열입니다.	예
nextLink	string	페이지를 매긴 다음 결과 집합에 대한 링크입니다(결과가 더 있는 경우, 그렇지 않으면 존재하지 않음).	아니요

IngestionDocumentRequestModel

JSON 문서의 비디오 문서 수집 요청을 나타냅니다.

이름	형식	설명	필수
mode	string	문서에 대한 수집 모드를 가져오거나 설정합니다. 열거형: "add", "update""remove"	예
documentId	string	문서 ID를 가져오거나 설정합니다.	아니요
documentUrl	문자열(URL)	문서 URL을 가져오거나 설정합니다. SAS(공유 액세스 서명)가 있는 경우 URL에서 제거됩니다.	예
metadata	개체	문서의 메타데이터를 이름-값 쌍의 사전으로 가져오거나 설정합니다.	아니요
UserData	개체	문서에 대한 사용자 데이터를 가져오거나 설정합니다.	아니요

IngestionDocumentResponseModel

JSON 문서의 수집 문서 응답 개체를 나타냅니다.

이름	형식	설명	필수
documentId	string	문서 ID를 가져오거나 설정합니다.	아니요
documentUrl	문자열(URL)	문서 URL을 가져오거나 설정합니다. SAS(공유 액세스 서명)가 있는 경우 URL에서 제거됩니다.	아니요
metadata	개체	메타데이터의 키-값 쌍을 가져오거나 설정합니다.	아니요
error	ErrorResponseDetails		아니요
createdDateTime	dateTime	문서의 만든 날짜 및 시간을 가져오거나 설정합니다.	아니요
lastModifiedDateTime	dateTime	문서의 마지막으로 수정한 날짜 및 시간을 가져오거나 설정합니다.	아니요
UserData	개체	문서에 대한 사용자 데이터를 가져오거나 설정합니다.	아니요

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"	아니요
error	ErrorResponseDetails		아니요
batchName	string	이 수집과 연결된 일괄 처리의 이름입니다.	아니요
createdDateTime	dateTime	수집의 생성된 날짜 및 시간을 가져오거나 설정합니다.	아니요
lastModifiedDateTime	dateTime	수집의 마지막으로 수정된 날짜 및 시간을 가져오거나 설정합니다.	아니요
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	각 문서의 수집 상태 목록입니다.	아니요

IngestionResponseModelCollectionApiModel

페이지를 매길 수 있는 결과 배열을 포함합니다.

이름	형식	설명	필수
value	[ IngestionResponseModel ]	결과의 배열입니다.	예
nextLink	string	페이지를 매긴 다음 결과 집합에 대한 링크입니다(결과가 더 있는 경우, 그렇지 않으면 존재하지 않음).	아니요

IngestionStatusDetailsApiModel

각 문서의 수집 상태 세부 정보를 나타냅니다.

이름	형식	설명	필수
lastUpdateTime	dateTime	일괄 처리 청크의 상태 업데이트 시간입니다.	예
documentId	string	문서 ID입니다.	예
documentUrl	문자열(URL)	문서의 URL입니다.	아니요
성공	부울 값	유추가 성공했는지 여부를 나타내는 플래그입니다.	예
error	IngestionErrorDetailsApiModel		아니요

MetadataSchemaFieldModel

메타데이터 스키마의 필드를 나타냅니다.

이름	형식	설명	필수
name	string	필드의 이름을 가져오거나 설정합니다.	예
searchable	부울 값	필드가 검색 가능한지 여부를 나타내는 값을 가져오거나 설정합니다.	예
filterable	부울 값	필드가 필터링 가능한지 여부를 나타내는 값을 가져오거나 설정합니다.	예
type	string	필드 유형을 가져오거나 설정합니다. 문자열 또는날짜/시간일 수 있습니다. 열거형: "string", "datetime"	예

MetadataSchemaModel

문서의 메타데이터 스키마를 나타냅니다.

이름	형식	설명	필수
언어	string	메타데이터 스키마의 언어를 가져오거나 설정합니다. 기본값은 "en"입니다.	아니요
필드	[ MetadataSchemaFieldModel ]	메타데이터 스키마의 필드 목록을 가져오거나 설정합니다.	예

SearchFiltersModel

검색 쿼리에 적용할 필터를 나타냅니다.

이름	형식	설명	필수
stringFilters	[ StringFilterModel ]	검색 쿼리에 적용할 문자열 필터를 가져오거나 설정합니다.	아니요
datetimeFilters	[ DatetimeFilterModel ]	검색 쿼리에 적용할 날짜/시간 필터를 가져오거나 설정합니다.	아니요
featureFilters	[ string ]	검색 쿼리에 적용할 기능 필터를 가져오거나 설정합니다.	아니요

SearchQueryTextRequestModel

텍스트 기반 검색에 대한 검색 쿼리 요청 모델을 나타냅니다.

이름	형식	설명	필수
queryText	string	쿼리 텍스트를 가져오거나 설정합니다.	예
필터	SearchFiltersModel		아니요
조정	부울 값	조정을 사용할지 여부를 나타내는 부울 값을 가져오거나 설정합니다.	아니요
최고	정수	검색할 결과 수를 가져오거나 설정합니다.	예
skip	정수	건너뛸 결과 수를 가져오거나 설정합니다.	예
additionalIndexNames	[ string ]	검색 쿼리에 포함할 추가 인덱스 이름을 가져오거나 설정합니다.	아니요
dedup	부울 값	유사한 비디오 프레임을 제거할지 여부입니다.	예
dedupMaxDocumentCount	정수	중복 제거 후의 최대 문서 수입니다.	예
disableMetadataSearch	부울 값	검색에서 메타데이터가 비활성화되었는지 여부를 나타내는 부울 값을 가져오거나 설정합니다.	예

SearchResultDocumentModel

검색 쿼리 응답을 나타냅니다.

이름	형식	설명	필수
documentId	string	문서의 ID를 가져오거나 설정합니다.	아니요
documentKind	string	"video"일 수 있는 문서의 종류를 가져오거나 설정합니다.	아니요
start	string	문서의 시작 시간을 가져오거나 설정합니다. 이 속성은 비디오 문서에만 적용할 수 있습니다.	아니요
end	string	문서의 종료 시간을 가져오거나 설정합니다. 이 속성은 비디오 문서에만 적용할 수 있습니다.	아니요
테스트	string	관련성 점수가 가장 높은 문서의 타임스탬프를 가져오거나 설정합니다. 이 속성은 비디오 문서에만 적용할 수 있습니다.	아니요
relevance	double	문서의 관련성 점수를 가져오거나 설정합니다.	예
additionalMetadata	개체	검색과 관련된 추가 메타데이터를 가져오거나 설정합니다.	아니요

SearchResultDocumentModelCollectionApiModel

페이지를 매길 수 있는 결과 배열을 포함합니다.

이름	형식	설명	필수
value	[ SearchResultDocumentModel ]	결과의 배열입니다.	예
nextLink	string	페이지를 매긴 다음 결과 집합에 대한 링크입니다(결과가 더 있는 경우, 그렇지 않으면 존재하지 않음).	아니요

StringFilterModel

검색 쿼리에 적용할 문자열 필터를 나타냅니다.

이름	형식	설명	필수
fieldName	string	필터링할 필드의 이름을 가져오거나 설정합니다.	예
values	[ string ]	필터링할 값을 가져오거나 설정합니다.	예

UpdateIngestionIndexRequestModel

JSON 문서에 대한 업데이트 수집 인덱스 요청 모델을 나타냅니다.

이름	형식	설명	필수
metadataSchema	MetadataSchemaModel		아니요
UserData	개체	문서에 대한 사용자 데이터를 가져오거나 설정합니다.	아니요