Справочник по API получения видео

Проверка подлинности

Включите следующие заголовки при вызове любого API в этом документе.

Ocp-Apim-Subscription-Key: версия: YOUR_COMPUTER_VISION_KEY2023-05-01-preview

CreateIndex

URL

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

Description

Этот метод создает индекс, который затем можно использовать для приема документов. Перед выполнением приема необходимо создать индекс.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя создаваемого индекса.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка
текст	текст	Текст запроса, содержащий метаданные, которые можно использовать для поиска.	Да	CreateIngestionIndexRequestModel

Отклики

Код	Description	Тип
201	Создано	GetIngestionIndexResponseModel

GetIndex

URL

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

Description

Извлекает индекс с указанным именем.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя извлекаемого индекса.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка

Отклики

Код	Description	Тип
200	Удачное завершение	GetIngestionIndexResponseModel
default	Ошибка	ErrorResponse

UpdateIndex

URL

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

Description

Обновляет индекс с указанным именем.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя обновляемого индекса.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка
текст	текст	Текст запроса, содержащий обновления, применяемые к индексу.	Да	UpdateIngestionIndexRequestModel

Отклики

Код	Description	Тип
200	Удачное завершение	GetIngestionIndexResponseModel
default	Ошибка	ErrorResponse

DeleteIndex

URL

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

Description

Удаляет индекс и все связанные с ним документы приема.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя индекса, который необходимо удалить.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка

Отклики

Код	Описание
204	Нет содержимого

ListIndexes

URL

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

Description

Извлекает список всех индексов во всех приемах.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
$skip	query	Количество пропущенных наборов данных.	No	integer
$top	query	Количество возвращаемых наборов данных после пропуска.	No	integer
api-version	query	Запрошенная версия API.	Да	строка

Отклики

Код	Description	Тип
200	Удачное завершение	GetIngestionIndexResponseModelCollectionApiModel
default	Ошибка	ErrorResponse

Создание приема

URL

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

Description

Запрос приема может содержать полезные данные видео. Он может иметь один из трех режимов (добавление, обновление или удаление). Добавьте режим создания приема и обработки видео. Режим обновления обновляет только метаданные. Чтобы повторно обработать видео, прием необходимо удалить и повторно создать.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя индекса, для которого необходимо создать прием.	Да	строка
ingestionName	path	Имя создаваемого приема.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка
текст	текст	Текст запроса, содержащий созданный запрос приема.	Да	CreateIngestionRequestModel

Отклики

Код	Description	Тип
202	Accepted	Прием данныхResponseModel

GetIngestion

URL

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

Description

Возвращает состояние приема для указанного индекса и имени приема.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя индекса, для которого необходимо проверить состояние приема.	Да	строка
ingestionName	path	Имя извлекаемого приема.	Да	строка
detailLevel	query	Уровень, указывающий уровень детализации для каждого документа.	Нет	строка
api-version	query	Запрошенная версия API.	Да	строка

Отклики

Код	Description	Тип
200	Удачное завершение	Прием данныхResponseModel
default	Ошибка	ErrorResponse

Перечисление

URL

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

Description

Извлекает все приемы для определенного индекса.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя индекса, для которого извлекаются приемы.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка

Отклики

Код	Description	Тип
200	Удачное завершение	ПриемresponseModelCollectionApiModel
default	Ошибка	ErrorResponse

ListDocuments

URL

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

Description

Извлекает все документы для определенного индекса.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя индекса, для которого нужно получить документы.	Да	строка
$skip	query	Количество пропущенных наборов данных.	No	integer
$top	query	Количество возвращаемых наборов данных после пропуска.	No	integer
api-version	query	Запрошенная версия API.	Да	строка

Отклики

Код	Description	Тип
200	Удачное завершение	IngestionDocumentResponseModelCollectionApiModel
default	Ошибка	ErrorResponse

SearchByText

URL

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

Description

Выполняет текстовый поиск по указанному индексу.

Параметры

Имя.	Расположение	Description	Обязательное поле	Тип
indexName	path	Имя индекса для поиска.	Да	строка
api-version	query	Запрошенная версия API.	Да	строка
текст	текст	Текст запроса, содержащий запрос и другие параметры.	Да	SearchQueryTextRequestModel

Отклики

Код	Description	Тип
200	Удачное завершение	SearchResultDocumentModelCollectionApiModel
default	Ошибка	ErrorResponse

Модели

CreateIngestionIndexRequestModel

Представляет модель запроса индекса приема для документа JSON.

Имя.	Тип	Описание	Обязательное поле
metadataSchema	MetadataSchemaModel		No
features	[ FeatureModel ]	Возвращает или задает список функций для документа. По умолчанию используется "визуальное представление".	No
userData	объект	Возвращает или задает данные пользователя для документа.	No

CreateIngestionRequestModel

Представляет модель запроса приема для документа JSON.

Имя.	Тип	Описание	Обязательное поле
videos	[ IngestionDocumentRequestModel ]	Возвращает или задает список запросов приема видеодокументов в документе JSON.	No
модерация	boolean	Возвращает или задает флаг модерации, указывающий, следует ли модерировать содержимое.	No
generateInsightIntervals	boolean	Возвращает или задает флаг создания интервалов, указывающий, следует ли создавать интервалы анализа.	No
documentAuthenticationKind	строка	Возвращает или задает тип проверки подлинности, используемый для скачивания документов. Перечисление: "none", "managedIdentity"	No
filterDefectedFrames	boolean	Флаг фильтра кадров, указывающий на то, что кадры будут оцениваться, а все дефектные (например, размытые, низкие, избыточные) кадры будут отфильтрованы.	No
includeSpeechTranscript	boolean	Возвращает или задает флаг создания расшифровки, указывающий, следует ли создать расшифровку.	No

DatetimeFilterModel

Представляет фильтр datetime для применения к поисковому запросу.

Имя.	Тип	Описание	Обязательное поле
fieldName	строка	Возвращает или задает имя поля для фильтрации.	Да
startTime	строка	Возвращает или задает время начала диапазона для фильтрации.	No
endTime	строка	Возвращает или задает время окончания диапазона для фильтрации.	No

ErrorResponse

Ответ возвращается при возникновении ошибки.

Имя.	Тип	Описание	Обязательное поле
error	ErrorResponseDetails		Да

ErrorResponseDetails

Сведения об ошибке.

Имя.	Тип	Описание	Обязательное поле
кодом	строка	Код ошибки.	Да
message	строка	Сообщение об ошибке.	Да
целевой объект	строка	Цель ошибки.	No
details	[ ErrorResponseDetails ]	Список подробных ошибок.	No
innererror	ErrorResponseInnerError		No

ErrorResponseInnerError

Подробная ошибка.

Имя.	Тип	Описание	Обязательное поле
кодом	строка	Код ошибки.	Да
message	строка	Сообщение об ошибке.	Да
innererror	ErrorResponseInnerError		No

FeatureModel

Представляет функцию в индексе.

Имя.	Тип	Описание	Обязательное поле
name	строка	Возвращает или задает имя функции. Перечисление: "vision", "speech"	Да
modelVersion	строка	Возвращает или задает версию модели компонента.	No
domain	строка	Возвращает или задает домен модели компонента. Перечисление: "generic", "surveillance"	No

GetIngestionIndexResponseModel

Представляет модель ответа индекса приема для документа JSON.

Имя.	Тип	Описание	Обязательное поле
name	строка	Возвращает или задает свойство имени индекса.	No
metadataSchema	MetadataSchemaModel		No
userData	объект	Возвращает или задает данные пользователя для документа.	No
features	[ FeatureModel ]	Возвращает или задает список функций в индексе.	No
eTag	строка	Возвращает или задает etag.	Да
createdDateTime	dateTime	Возвращает или задает созданное свойство даты и времени.	Да
lastModifiedDateTime	dateTime	Возвращает или задает последнее измененное свойство даты и времени.	Да

GetIngestionIndexResponseModelCollectionApiModel

Содержит массив результатов, которые могут быть разбиены на страницы.

Имя.	Тип	Описание	Обязательное поле
значение	[ GetIngestionIndexResponseModel ]	Массив результатов.	Да
nextLink	строка	Ссылка на следующий набор результатов с разбивкой на страницы, если доступны дополнительные результаты; не присутствует в противном случае.	No

ПриемDocumentRequestModel

Представляет запрос приема видеодокумента в документе JSON.

Имя.	Тип	Описание	Обязательное поле
mode	строка	Возвращает или задает режим приема для документа. Перечисление: "add", , "update""remove"	Да
documentId	строка	Возвращает или задает идентификатор документа.	No
documentUrl	string (URI)	Возвращает или задает URL-адрес документа. Подписанный URL-адрес (SAS), если таковой есть, будет удален из URL-адреса.	Да
metadata	объект	Возвращает или задает метаданные для документа в виде словаря пар "имя-значение".	No
userData	объект	Возвращает или задает данные пользователя для документа.	No

Прием IngestionDocumentResponseModel

Представляет объект ответа документа приема в документе JSON.

Имя.	Тип	Описание	Обязательное поле
documentId	строка	Возвращает или задает идентификатор документа.	No
documentUrl	string (URI)	Возвращает или задает URL-адрес документа. Подписанный URL-адрес (SAS), если таковой есть, будет удален из URL-адреса.	No
metadata	объект	Возвращает или задает пары "ключ-значение" метаданных.	No
error	ErrorResponseDetails		No
createdDateTime	dateTime	Возвращает или задает созданную дату и время документа.	No
lastModifiedDateTime	dateTime	Возвращает или задает дату и время последнего изменения документа.	No
userData	объект	Возвращает или задает данные пользователя для документа.	No

IngestionDocumentResponseModelCollectionApiModel

Содержит массив результатов, которые могут быть разбиены на страницы.

Имя.	Тип	Описание	Обязательное поле
значение	[ IngestionDocumentResponseModel ]	Массив результатов.	Да
nextLink	строка	Ссылка на следующий набор результатов с разбивкой на страницы, если доступны дополнительные результаты; не присутствует в противном случае.	No

ПриемErrorDetailsApiModel

Представляет сведения об ошибке приема для каждого документа.

Имя.	Тип	Описание	Обязательное поле
кодом	строка	Код ошибки.	No
message	строка	Сообщение об ошибке.	No
innerError	ПриемInnerErrorDetailsApiModel		No

ПриемInnerErrorDetailsApiModel

Представляет сведения о приеме внутренних ошибок для каждого документа.

Имя.	Тип	Описание	Обязательное поле
кодом	строка	Код ошибки.	No
message	строка	Сообщение об ошибке.	No
innerError	ПриемInnerErrorDetailsApiModel		No

Прием данныхResponseModel

Представляет модель ответа приема для документа JSON.

Имя.	Тип	Описание	Обязательное поле
name	строка	Возвращает или задает имя приема.	No
state	string	Возвращает или задает состояние приема. Перечисление: "notStarted", , "failed""running""completed""partiallySucceeded"	No
error	ErrorResponseDetails		No
batchName	строка	Имя пакета, связанного с этим приемом.	No
createdDateTime	dateTime	Возвращает или задает созданную дату и время приема.	No
lastModifiedDateTime	dateTime	Возвращает или задает последнюю измененную дату и время приема.	No
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	Список состояний приема для каждого документа.	No

ПриемresponseModelCollectionApiModel

Содержит массив результатов, которые могут быть разбиены на страницы.

Имя.	Тип	Описание	Обязательное поле
значение	[ IngestionResponseModel ]	Массив результатов.	Да
nextLink	строка	Ссылка на следующий набор результатов с разбивкой на страницы, если доступны дополнительные результаты; не присутствует в противном случае.	No

IngestionStatusDetailsApiModel

Представляет сведения о состоянии приема для каждого документа.

Имя.	Тип	Описание	Обязательное поле
LastUpdateTime	dateTime	Время обновления состояния блока пакетной службы.	Да
documentId	строка	Идентификатор документа.	Да
documentUrl	string (URI)	URL-адрес документа.	No
Выполнено	boolean	Флаг, указывающий, был ли вывод успешным.	Да
error	ПриемErrorDetailsApiModel		No

MetadataSchemaFieldModel

Представляет поле в схеме метаданных.

Имя.	Тип	Описание	Обязательное поле
name	строка	Возвращает или задает имя поля.	Да
searchable	boolean	Возвращает или задает значение, указывающее, можно ли выполнять поиск по полю.	Да
Фильтруемый	boolean	Возвращает или задает значение, указывающее, можно ли фильтровать поле.	Да
type	строка	Возвращает или задает тип поля. Это может быть строка или дата и время. Перечисление: "string", "datetime"	Да

MetadataSchemaModel

Представляет схему метаданных для документа.

Имя.	Тип	Описание	Обязательное поле
язык	string	Возвращает или задает язык схемы метаданных. Значение по умолчанию — en.	No
столбцов	[ MetadataSchemaFieldModel ]	Возвращает или задает список полей в схеме метаданных.	Да

SearchFiltersModel

Представляет фильтры, применяемые к поисковому запросу.

Имя.	Тип	Описание	Обязательное поле
stringFilters	[ StringFilterModel ]	Возвращает или задает фильтры строк для применения к поисковому запросу.	No
datetimeFilters	[ DatetimeFilterModel ]	Возвращает или задает фильтры даты и времени, применяемые к поисковому запросу.	No
featureFilters	[ строка ]	Возвращает или задает фильтры функций, применяемые к поисковому запросу.	No

SearchQueryTextRequestModel

Представляет модель запроса поиска для текстового поиска.

Имя.	Тип	Описание	Обязательное поле
queryText	строка	Возвращает или задает текст запроса.	Да
фильтры	SearchFiltersModel		No
модерация	boolean	Возвращает или задает логическое значение, указывающее, включена ли модерация или отключена.	No
популярное	integer	Возвращает или задает количество полученных результатов.	Да
skip	integer	Возвращает или задает количество пропущенных результатов.	Да
additionalIndexNames	[ строка ]	Возвращает или задает дополнительные имена индексов для включения в поисковый запрос.	No
dedup	boolean	Следует ли удалять аналогичные видеокадры.	Да
дедупMaxDocumentCount	integer	Максимальное количество документов после дедупации.	Да
disableMetadataSearch	boolean	Возвращает или задает логическое значение, указывающее, отключены ли метаданные в поиске.	Да

SearchResultDocumentModel

Представляет ответ поискового запроса.

Имя.	Тип	Описание	Обязательное поле
documentId	строка	Возвращает или задает идентификатор документа.	No
documentKind	строка	Возвращает или задает тип документа, который может быть "видео".	No
start	строка	Возвращает или задает время начала документа. Это свойство применимо только для видео документов.	No
end	строка	Возвращает или задает время окончания документа. Это свойство применимо только для видео документов.	No
test	строка	Возвращает или задает метку времени документа с самой высокой оценкой релевантности. Это свойство применимо только для видео документов.	No
уместность	двойной точности	Возвращает или задает оценку релевантности документа.	Да
дополнительные метаданные	объект	Возвращает или задает дополнительные метаданные, связанные с поиском.	No

SearchResultDocumentModelCollectionApiModel

Содержит массив результатов, которые могут быть разбиены на страницы.

Имя.	Тип	Описание	Обязательное поле
значение	[ SearchResultDocumentModel ]	Массив результатов.	Да
nextLink	строка	Ссылка на следующий набор результатов с разбивкой на страницы, если доступны дополнительные результаты; не присутствует в противном случае.	No

StringFilterModel

Представляет строковый фильтр для применения к поисковому запросу.

Имя.	Тип	Описание	Обязательное поле
fieldName	строка	Возвращает или задает имя поля для фильтрации.	Да
Значения	[ строка ]	Возвращает или задает значения для фильтрации.	Да

UpdateIngestionIndexRequestModel

Представляет модель запроса индекса приема обновлений для документа JSON.

Имя.	Тип	Описание	Обязательное поле
metadataSchema	MetadataSchemaModel		No
userData	объект	Возвращает или задает данные пользователя для документа.	No