Referencia de API de recuperación de vídeo

Autenticación

Incluya los siguientes encabezados al realizar una llamada a cualquier API de este documento.

Ocp-Apim-Subscription-Key: Versión: YOUR_COMPUTER_VISION_KEY2023-05-01-preview

CreateIndex

URL

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

Descripción

Este método crea un índice que se puede usar para ingerir documentos. Es necesario crear un índice antes de que se pueda realizar la ingesta.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice que se va a crear.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena
body	body	Cuerpo de la solicitud que contiene los metadatos que se pueden usar para la búsqueda.	Sí	CreateIngestionIndexRequestModel

Respuestas

Código	Descripción	Tipo
201	Fecha de creación	GetIngestionIndexResponseModel

GetIndex

URL

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

Descripción

Recupera el índice con el nombre especificado.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	El nombre del índice que se va a volver a recuperar.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena

Respuestas

Código	Descripción	Tipo
200	Correcto	GetIngestionIndexResponseModel
default	Error	ErrorResponse

UpdateIndex

URL

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

Descripción

Actualiza un índice con el nombre especificado.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice que se va a actualizar.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena
body	body	Cuerpo de la solicitud que contiene las actualizaciones que se van a aplicar al índice.	Sí	UpdateIngestionIndexRequestModel

Respuestas

Código	Descripción	Tipo
200	Correcto	GetIngestionIndexResponseModel
default	Error	ErrorResponse

DeleteIndex

URL

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

Descripción

Elimina un índice y todos sus documentos de ingesta asociados.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice que se va a eliminar.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena

Respuestas

Código	Descripción
204	Ningún contenido

ListIndexes

URL

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

Descripción

Recupera una lista de todos los índices en todas las ingestas.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
$skip	Query	Número de conjuntos de datos que se van a omitir.	No	integer
$top	Query	Número de conjuntos de datos que se van a devolver después de omitir.	No	integer
api-version	Query	Versión de API solicitada.	Sí	cadena

Respuestas

Código	Descripción	Tipo
200	Correcto	GetIngestionIndexResponseModelCollectionApiModel
default	Error	ErrorResponse

CreateIngestion

URL

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

Descripción

La solicitud de ingesta puede tener carga de vídeo. Puede tener uno de los tres modos (agregar, actualizar o quitar). Agregar modo creará una ingesta y procesará el vídeo. El modo de actualización solo actualizará los metadatos. Para volver a procesar el vídeo, la ingesta debe eliminarse y volver a crearse.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice al que se va a crear la ingesta.	Sí	cadena
ingestionName	path	Nombre de la ingesta que se va a crear.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena
body	body	Cuerpo de la solicitud que contiene la solicitud de ingesta que se va a crear.	Sí	CreateIngestionRequestModel

Respuestas

Código	Descripción	Tipo
202	Aceptadas	IngestionResponseModel

GetIngestion

URL

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

Descripción

Obtiene el estado de ingesta del índice especificado y el nombre de ingesta.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice para el que se va a comprobar el estado de ingesta.	Sí	cadena
ingestionName	path	Nombre de la ingesta que se va a recuperar.	Sí	cadena
detailLevel	Query	Nivel para indicar el nivel de detalle por estado de ingesta de documentos.	No	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena

Respuestas

Código	Descripción	Tipo
200	Correcto	IngestionResponseModel
default	Error	ErrorResponse

ListIngestions

URL

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

Descripción

Recupera todas las ingestas del índice específico.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice para el que se van a recuperar las ingestas.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena

Respuestas

Código	Descripción	Tipo
200	Correcto	IngestionResponseModelCollectionApiModel
default	Error	ErrorResponse

ListDocuments

URL

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

Descripción

Recupera todos los documentos del índice específico.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	Nombre del índice para el que se van a recuperar los documentos.	Sí	cadena
$skip	Query	Número de conjuntos de datos que se van a omitir.	No	integer
$top	Query	Número de conjuntos de datos que se van a devolver después de omitir.	No	integer
api-version	Query	Versión de API solicitada.	Sí	cadena

Respuestas

Código	Descripción	Tipo
200	Correcto	IngestionDocumentResponseModelCollectionApiModel
default	Error	ErrorResponse

SearchByText

URL

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

Descripción

Realiza una búsqueda basada en texto en el índice especificado.

Parámetros

Nombre	Ubicado en	Descripción	Obligatorio	Tipo
indexName	path	El nombre del índice que se va a buscar.	Sí	cadena
api-version	Query	Versión de API solicitada.	Sí	cadena
body	body	Cuerpo de la solicitud que contiene la consulta y otros parámetros.	Sí	SearchQueryTextRequestModel

Respuestas

Código	Descripción	Tipo
200	Correcto	SearchResultDocumentModelCollectionApiModel
default	Error	ErrorResponse

Models

CreateIngestionIndexRequestModel

Representa el modelo de solicitud de índice de creación de ingesta para el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
metadataSchema	MetadataSchemaModel		No
Características	[ FeatureModel ]	Obtiene o establece la lista de características del documento. El valor predeterminado es "vision".	No
userData	object	Obtiene o establece los datos de usuario del documento.	No

CreateIngestionRequestModel

Representa el modelo de solicitud de creación de ingesta para el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
Vídeos	[ IngestionDocumentRequestModel ]	Obtiene o establece la lista de solicitudes de ingesta de documentos de vídeo en el documento JSON.	No
moderación	boolean	Obtiene o establece la marca de moderación, que indica si el contenido debe moderarse.	No
generateInsightIntervals	boolean	Obtiene o establece la marca de generación de intervalos, que indica si se deben generar intervalos de información.	No
documentAuthenticationKind	cadena	Obtiene o establece el tipo de autenticación que se va a usar para descargar los documentos. Enumeración: "none", "managedIdentity"	No
filterDefectedFrames	boolean	Se evaluará la marca de filtro del marco que indica los fotogramas y se filtrarán todos los fotogramas defectuosos (por ejemplo, desenfocados, poca luz, sobreexposición).	No
includeSpeechTranscript	boolean	Obtiene o establece la marca de generación de transcripciones, que indica si se debe generar la transcripción.	No

DatetimeFilterModel

Representa un filtro datetime que se va a aplicar en una consulta de búsqueda.

Nombre	Escribir	Descripción	Obligatorio
fieldName	cadena	Obtiene o establece el nombre del campo en el que se va a filtrar.	Sí
startTime	cadena	Obtiene o establece la hora de inicio del intervalo en el que se va a filtrar.	No
endTime	cadena	Obtiene o establece la hora de finalización del rango en el que se va a filtrar.	No

ErrorResponse

Respuesta devuelta cuando se produce un error.

Nombre	Escribir	Descripción	Obligatorio
error	ErrorResponseDetails		Sí

ErrorResponseDetails

Información del error.

Nombre	Escribir	Descripción	Obligatorio
code	cadena	Código de error.	Sí
message	cadena	Mensaje de error.	Sí
Destino	cadena	Destino del error.	No
detalles	[ ErrorResponseDetails ]	Lista de errores detallados.	No
innererror	ErrorResponseInnerError		No

ErrorResponseInnerError

Error detallado.

Nombre	Escribir	Descripción	Obligatorio
code	cadena	Código de error.	Sí
message	cadena	Mensaje de error.	Sí
innererror	ErrorResponseInnerError		No

FeatureModel

Representa una característica en el índice.

Nombre	Escribir	Descripción	Obligatorio
name	cadena	Obtiene o establece el nombre de la característica. Enumeración: "vision", "speech"	Sí
modelVersion	cadena	Obtiene o establece la versión del modelo de la característica.	No
dominio	cadena	Obtiene o establece el dominio del modelo de la característica. Enumeración: "generic", "surveillance"	No

GetIngestionIndexResponseModel

Representa el modelo de respuesta del índice de ingesta get para el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
name	cadena	Obtiene o establece la propiedad del nombre de índice.	No
metadataSchema	MetadataSchemaModel		No
userData	object	Obtiene o establece los datos de usuario del documento.	No
Características	[ FeatureModel ]	Obtiene o establece la lista de características del índice.	No
eTag	cadena	Obtiene o establece la etiqueta de entidad.	Sí
createdDateTime	dateTime	Obtiene o establece la propiedad de fecha y hora de creación.	Sí
lastModifiedDateTime	dateTime	Obtiene o establece la propiedad de fecha y hora de la última modificación.	Sí

GetIngestionIndexResponseModelCollectionApiModel

Contiene una matriz de resultados que se pueden paginar.

Nombre	Escribir	Descripción	Obligatorio
value	[ GetIngestionIndexResponseModel ]	Matriz de resultados.	Sí
nextLink	cadena	Vínculo al siguiente conjunto de resultados paginados, si hay más resultados disponibles; de lo contrario, no está presente.	No

IngestionDocumentRequestModel

Representa una solicitud de ingesta de documentos de vídeo en el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
mode	cadena	Obtiene o establece el modo de la ingesta para el documento. Enumeración: "add", , "update""remove"	Sí
documentId	cadena	Obtiene o establece el id. del documento.	No
documentUrl	cadena (URI)	Obtiene o establece la dirección URL del documento. Firma de acceso compartido (SAS). Si existe, se quitará de la dirección URL.	Sí
metadata	object	Obtiene o establece los metadatos del documento como un diccionario de pares nombre-valor.	No
userData	object	Obtiene o establece los datos de usuario del documento.	No

IngestionDocumentResponseModel

Representa un objeto de respuesta del documento de ingesta en el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
documentId	cadena	Obtiene o establece el id. del documento.	No
documentUrl	cadena (URI)	Obtiene o establece la dirección URL del documento. Firma de acceso compartido (SAS). Si existe, se quitará de la dirección URL.	No
metadata	object	Obtiene o establece los pares clave-valor de los metadatos.	No
error	ErrorResponseDetails		No
createdDateTime	dateTime	Obtiene o establece la fecha y hora de creación del documento.	No
lastModifiedDateTime	dateTime	Obtiene o establece la fecha y hora de la última modificación del documento.	No
userData	object	Obtiene o establece los datos de usuario del documento.	No

IngestionDocumentResponseModelCollectionApiModel

Contiene una matriz de resultados que se pueden paginar.

Nombre	Escribir	Descripción	Obligatorio
value	[ IngestionDocumentResponseModel ]	Matriz de resultados.	Sí
nextLink	cadena	Vínculo al siguiente conjunto de resultados paginados, si hay más resultados disponibles; de lo contrario, no está presente.	No

IngestionErrorDetailsApiModel

Representa la información de error de ingesta de cada documento.

Nombre	Escribir	Descripción	Obligatorio
code	cadena	Código de error.	No
message	cadena	Mensaje de error.	No
innerError	IngestionInnerErrorDetailsApiModel		No

IngestionInnerErrorDetailsApiModel

Representa la información de error interno de ingesta para cada documento.

Nombre	Escribir	Descripción	Obligatorio
code	cadena	Código de error.	No
message	cadena	Mensaje de error.	No
innerError	IngestionInnerErrorDetailsApiModel		No

IngestionResponseModel

Representa el modelo de respuesta de ingesta para el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
name	cadena	Obtiene o establece el nombre de la ingesta.	No
state	cadena	Obtiene o establece el estado de la ingesta. Enumeración: "notStarted", "running", "completed", , "failed", "partiallySucceeded"	No
error	ErrorResponseDetails		No
batchName	cadena	Nombre del lote asociado a esta ingesta.	No
createdDateTime	dateTime	Obtiene o establece la fecha y hora de creación de la ingesta.	No
lastModifiedDateTime	dateTime	Obtiene o establece la fecha y hora de la última modificación de la ingesta.	No
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	Lista de los estados de ingesta para cada documento.	No

IngestionResponseModelCollectionApiModel

Contiene una matriz de resultados que se pueden paginar.

Nombre	Escribir	Descripción	Obligatorio
value	[ IngestionResponseModel ]	Matriz de resultados.	Sí
nextLink	cadena	Vínculo al siguiente conjunto de resultados paginados, si hay más resultados disponibles; de lo contrario, no está presente.	No

IngestionStatusDetailsApiModel

Representa el detalle del estado de ingesta de cada documento.

Nombre	Escribir	Descripción	Obligatorio
lastUpdateTime	dateTime	Hora de actualización del estado del fragmento de lote.	Sí
documentId	cadena	El identificador del documento.	Sí
documentUrl	cadena (URI)	Dirección URL del documento.	No
succeeded	boolean	Marca que indica si la inferencia se realizó correctamente.	Sí
error	IngestionErrorDetailsApiModel		No

MetadataSchemaFieldModel

Representa un campo en el esquema de metadatos.

Nombre	Escribir	Descripción	Obligatorio
name	cadena	Obtiene o establece el nombre del campo.	Sí
searchable	boolean	Obtiene o establece un valor que indica si el campo se puede buscar.	Sí
filterable	boolean	Obtiene o establece un valor que indica si el campo se puede filtrar.	Sí
type	cadena	Obtiene o establece el tipo de campo. Podría ser string o datetime. Enumeración: "string", "datetime"	Sí

MetadataSchemaModel

Representa el esquema de metadatos del documento.

Nombre	Escribir	Descripción	Obligatorio
language	cadena	Obtiene o establece el idioma del esquema de metadatos. El valor predeterminado es “en”.	No
fields	[ MetadataSchemaFieldModel ]	Obtiene o establece la lista de campos del esquema de metadatos.	Sí

SearchFiltersModel

Representa los filtros que se van a aplicar en una consulta de búsqueda.

Nombre	Escribir	Descripción	Obligatorio
stringFilters	[ StringFilterModel ]	Obtiene o establece los filtros de cadena que se van a aplicar en la consulta de búsqueda.	No
datetimeFilters	[ DatetimeFilterModel ]	Obtiene o establece los filtros datetime que se van a aplicar en la consulta de búsqueda.	No
featureFilters	[ cadena ]	Obtiene o establece los filtros de características que se van a aplicar en la consulta de búsqueda.	No

SearchQueryTextRequestModel

Representa un modelo de solicitud de consulta de búsqueda para la búsqueda basada en texto.

Nombre	Escribir	Descripción	Obligatorio
queryText	cadena	Obtiene o establece el texto de la consulta.	Sí
filters	SearchFiltersModel		No
moderación	boolean	Obtiene o establece un valor booleano que indica si la moderación está habilitada o deshabilitada.	No
top	integer	Obtiene o establece el número de resultados que se van a recuperar.	Sí
skip	integer	Obtiene o establece el número de resultados que se van a omitir.	Sí
additionalIndexNames	[ cadena ]	Obtiene o establece los nombres de índice adicionales que se van a incluir en la consulta de búsqueda.	No
dedup	boolean	Si se van a quitar fotogramas de vídeo similares.	Sí
dedupMaxDocumentCount	integer	Número máximo de documentos después de dedup.	Sí
disableMetadataSearch	boolean	Obtiene o establece un valor booleano que indica si los metadatos están deshabilitados en la búsqueda o no.	Sí

SearchResultDocumentModel

Representa una respuesta de consulta de búsqueda.

Nombre	Escribir	Descripción	Obligatorio
documentId	cadena	Obtiene o establece el id. del documento.	No
documentKind	cadena	Obtiene o establece el tipo del documento, que puede ser "vídeo".	No
start	cadena	Obtiene o establece la hora de inicio del documento. Esta propiedad solo es aplicable a los documentos de vídeo.	No
end	cadena	Obtiene o establece la hora de finalización del documento. Esta propiedad solo es aplicable a los documentos de vídeo.	No
prueba	cadena	Obtiene o establece la marca de tiempo del documento con la puntuación de relevancia más alta. Esta propiedad solo es aplicable a los documentos de vídeo.	No
relevance	doble	Obtiene o establece la puntuación de relevancia del documento.	Sí
additionalMetadata	object	Obtiene o establece los metadatos adicionales relacionados con la búsqueda.	No

SearchResultDocumentModelCollectionApiModel

Contiene una matriz de resultados que se pueden paginar.

Nombre	Escribir	Descripción	Obligatorio
value	[ SearchResultDocumentModel ]	Matriz de resultados.	Sí
nextLink	cadena	Vínculo al siguiente conjunto de resultados paginados, si hay más resultados disponibles; de lo contrario, no está presente.	No

StringFilterModel

Representa el filtro de cadena que se va a aplicar en una consulta de búsqueda.

Nombre	Escribir	Descripción	Obligatorio
fieldName	cadena	Obtiene o establece el nombre del campo en el que se va a filtrar.	Sí
valores	[ cadena ]	Obtiene o establece los valores por los que se va a filtrar.	Sí

UpdateIngestionIndexRequestModel

Representa el modelo de solicitud del índice de ingesta de actualizaciones para el documento JSON.

Nombre	Escribir	Descripción	Obligatorio
metadataSchema	MetadataSchemaModel		No
userData	object	Obtiene o establece los datos de usuario del documento.	No