Informations de référence sur l’API de récupération vidéo

Authentification

Incluez les en-têtes suivants lors de l’appel à n’importe quelle API dans ce document.

Ocp-Apim-Subscription-Key : YOUR_COMPUTER_VISION_KEY Version : 2023-05-01-preview

CreateIndex

URL

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

Description

Cette méthode crée un index, qui peut ensuite être utilisé pour ingérer des documents. Un index doit être créé avant de pouvoir effectuer l’ingestion.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index devant être créé.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string
corps	corps	Le corps de la requête contenant les métadonnées qui peuvent être utilisées pour la recherche.	Oui	CreateIngestionIndexRequestModel

Réponses

Code	Description	Type
201	Créé	GetIngestionIndexResponseModel

GetIndex

URL

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

Description

Récupère l’index portant le nom spécifié.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index à récupérer.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string

Réponses

Code	Description	Type
200	Opération réussie	GetIngestionIndexResponseModel
default	Erreur	ErrorResponse

UpdateIndex

URL

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

Description

Met à jour un index portant le nom spécifié.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index à mettre à jour.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string
corps	corps	Le corps de la requête contenant les mises à jour à appliquer à l’index.	Oui	UpdateIngestionIndexRequestModel

Réponses

Code	Description	Type
200	Opération réussie	GetIngestionIndexResponseModel
default	Erreur	ErrorResponse

DeleteIndex

URL

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

Description

Supprime un index et toutes ses ingestions de documents liées.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index à supprimer.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string

Réponses

Code	Description
204	Pas de contenu

ListIndexes

URL

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

Description

Récupère une liste de tous les index sur toutes les ingestions.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
$skip	query	Le nombre de jeux de données à sauter.	Non	entier
$top	query	Le nombre de jeux de données à renvoyer après le saut.	Non	entier
api-version	query	La version de l’API demandée.	Oui	string

Réponses

Code	Description	Type
200	Opération réussie	GetIngestionIndexResponseModelCollectionApiModel
default	Erreur	ErrorResponse

CreateIngestion

URL

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

Description

La demande d’ingestion peut avoir une charge utile vidéo. Elle peut avoir l’un des trois modes (ajouter, mettre à jour ou supprimer). Le mode Ajouter crée une ingestion et traite la vidéo. Le mode mise à jour met à jour les métadonnées uniquement. Pour retraiter la vidéo, l’ingestion doit être supprimée et recréée.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index auquel l’ingestion doit être créée.	Oui	string
ingestionName	path	Le nom de l’ingestion à créer.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string
corps	corps	Le corps de la requête contenant la demande d’ingestion à créer.	Oui	CreateIngestionRequestModel

Réponses

Code	Description	Type
202	Accepted	IngestionResponseModel

GetIngestion

URL

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

Description

Récupère l’état d’ingestion pour l’index et le nom d’ingestion spécifiés.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index pour lequel l’état d’ingestion doit être examiné.	Oui	string
ingestionName	path	Le nom de l’ingestion à récupérer.	Oui	string
detailLevel	query	Un niveau pour indiquer le niveau de détail par état d’ingestion de document.	Non	string
api-version	query	La version de l’API demandée.	Oui	string

Réponses

Code	Description	Type
200	Opération réussie	IngestionResponseModel
default	Erreur	ErrorResponse

ListIngestions

URL

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

Description

Récupère toutes les ingestions pour l’index spécifique.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index où récupérer les ingestions.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string

Réponses

Code	Description	Type
200	Opération réussie	IngestionResponseModelCollectionApiModel
default	Erreur	ErrorResponse

ListDocuments

URL

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

Description

Récupère tous les documents pour l’index spécifique.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index où récupérer les documents.	Oui	string
$skip	query	Le nombre de jeux de données à sauter.	Non	entier
$top	query	Le nombre de jeux de données à renvoyer après le saut.	Non	entier
api-version	query	La version de l’API demandée.	Oui	string

Réponses

Code	Description	Type
200	Opération réussie	IngestionDocumentResponseModelCollectionApiModel
default	Erreur	ErrorResponse

SearchByText

URL

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

Description

Effectue une recherche textuelle sur l’index spécifié.

Paramètres

Nom	Emplacement	Description	Obligatoire	Type
indexName	path	Le nom de l’index à rechercher.	Oui	string
api-version	query	La version de l’API demandée.	Oui	string
corps	corps	Le corps de la requête contenant la requête et d’autres paramètres.	Oui	SearchQueryTextRequestModel

Réponses

Code	Description	Type
200	Opération réussie	SearchResultDocumentModelCollectionApiModel
default	Erreur	ErrorResponse

Modèles

CreateIngestionIndexRequestModel

Représente le modèle de requête de création d’index d’ingestion pour le document JSON.

Nom	Type	Description	Obligatoire
metadataSchema	MetadataSchemaModel		Non
features	[ FeatureModel ]	Obtient ou définit la liste de fonctionnalités du document. La valeur par défaut est « vision ».	Non
userData	object	Obtient ou définit les données utilisateur pour le document.	Non

CreateIngestionRequestModel

Représente le modèle de demande de création d’ingestion pour le document JSON.

Nom	Type	Description	Obligatoire
Vidéos	[ IngestionDocumentRequestModel ]	Obtient ou définit la liste des demandes d’ingestion de documents vidéo dans le document JSON.	Non
modération	boolean	Obtient ou définit l’indicateur de modération, indiquant si le contenu doit être modéré.	Non
generateInsightIntervals	boolean	Obtient ou définit l’indicateur de génération d’intervalles, indiquant sur les intervalles d’insight doivent être générés.	Non
documentAuthenticationKind	string	Obtient ou définit le type d’authentification à utiliser pour télécharger les documents. Énumération : "none", "managedIdentity"	Non
filterDefectedFrames	boolean	L’indicateur de filtre d’images indiquant que les images sont évaluées et que toutes les images de mauvaise qualité (par exemple en cas de flou, de basse lumière, de surexposition) seront filtrées.	Non
includeSpeechTranscript	booléen	Obtient ou définit le drapeau de génération de transcription, indiquant si la transcription doit être générée.	Non

DatetimeFilterModel

Représente un filtre dateheure à appliquer sur une requête de recherche.

Nom	Type	Description	Obligatoire
fieldName	string	Obtient ou définit le nom de la propriété à filtrer.	Oui
startTime	string	Obtient ou définit l’heure de début de la plage à filtrer.	Non
endTime	string	Obtient ou définit l’heure de fin de la plage à filtrer.	Non

ErrorResponse

Réponse renvoyée lorsqu’une erreur se produit.

Nom	Type	Description	Obligatoire
error	ErrorResponseDetails		Oui

ErrorResponseDetails

Infos erreur.

Nom	Type	Description	Obligatoire
code	string	Code d’erreur.	Oui
message	string	Message d’erreur.	Oui
cible	string	Cible de l’erreur.	Non
details	[ ErrorResponseDetails ]	Liste des erreurs détaillées.	Non
innererror	ErrorResponseInnerError		Non

ErrorResponseInnerError

Erreur détaillée.

Nom	Type	Description	Obligatoire
code	string	Code d’erreur.	Oui
message	string	Message d’erreur.	Oui
innererror	ErrorResponseInnerError		Non

FeatureModel

Représente une fonctionnalité dans l’index.

Nom	Type	Description	Obligatoire
name	chaîne	Obtient ou définit le nom de la fonctionnalité. Énumération : "vision", "speech"	Oui
modelVersion	string	Obtient ou définit la version de modèle de la fonctionnalité.	Non
domaine	string	Obtient ou définit le domaine de modèle de la fonctionnalité. Énumération : "generic", "surveillance"	Non

GetIngestionIndexResponseModel

Représente le modèle de réponse de requête d’index d’ingestion pour le document JSON.

Nom	Type	Description	Obligatoire
name	chaîne	Obtient ou définit la propriété du nom d’index.	Non
metadataSchema	MetadataSchemaModel		Non
userData	object	Obtient ou définit les données utilisateur pour le document.	Non
features	[ FeatureModel ]	Obtient ou définit la liste des fonctionnalités dans l’index.	Non
eTag	string	Obtient ou définit l’etag.	Oui
createdDateTime	dateTime	Obtient ou définit la propriété de date et d’heure de création.	Oui
lastModifiedDateTime	dateTime	Obtient ou définit la propriété de date et d’heure de dernière modification.	Oui

GetIngestionIndexResponseModelCollectionApiModel

Contient un tableau de résultats pouvant être paginés.

Nom	Type	Description	Obligatoire
value	[ GetIngestionIndexResponseModel ]	Le tableau de résultats.	Oui
nextLink	string	Un lien vers le groupe suivant de résultats paginés, s’il y a d’autres résultats disponibles; non présent dans le cas contraire.	Non

IngestionDocumentRequestModel

Représente une demande d’ingestion de document vidéo dans le document JSON.

Nom	Type	Description	Obligatoire
mode	string	Obtient ou définit le mode d’ingestion pour le document. Énumération : "add", "update", "remove"	Oui
documentId	string	Obtient ou définit l’ID de document.	Non
documentUrl	chaîne (uri)	Obtient ou définit l’URL de document. La signature d’accès partagé (SAP), le cas échéant, sera supprimée de l’URL.	Oui
metadata	object	Obtient ou définit les métadonnées du document en tant que dictionnaire de paires nom-valeur.	Non
userData	object	Obtient ou définit les données utilisateur pour le document.	Non

IngestionDocumentResponseModel

Représente un objet de réponse de document d’ingestion dans le document JSON.

Nom	Type	Description	Obligatoire
documentId	string	Obtient ou définit l’ID de document.	Non
documentUrl	chaîne (uri)	Obtient ou définit l’URL de document. La signature d’accès partagé (SAP), le cas échéant, sera supprimée de l’URL.	Non
metadata	object	Obtient ou définit les paires clé-valeur de métadonnées.	Non
error	ErrorResponseDetails		Non
createdDateTime	dateTime	Obtient ou définit la date et l’heure de création du document.	Non
lastModifiedDateTime	dateTime	Obtient ou définit la date et l’heure de dernière modification du document.	Non
userData	object	Obtient ou définit les données utilisateur pour le document.	Non

IngestionDocumentResponseModelCollectionApiModel

Contient un tableau de résultats pouvant être paginés.

Nom	Type	Description	Obligatoire
value	[ IngestionDocumentResponseModel ]	Le tableau de résultats.	Oui
nextLink	string	Un lien vers le groupe suivant de résultats paginés, s’il y a d’autres résultats disponibles; non présent dans le cas contraire.	Non

IngestionErrorDetailsApiModel

Représente les informations d’erreur d’ingestion pour chaque document.

Nom	Type	Description	Obligatoire
code	string	Code d’erreur.	Non
message	string	Message d’erreur.	Non
innerError	IngestionInnerErrorDetailsApiModel		Non

IngestionInnerErrorDetailsApiModel

Représente les informations d’erreur d’ingestion intérieures pour chaque document.

Nom	Type	Description	Obligatoire
code	string	Code d’erreur.	Non
message	string	Message d’erreur.	Non
innerError	IngestionInnerErrorDetailsApiModel		Non

IngestionResponseModel

Représente le modèle de réponse d’ingestion pour le document JSON.

Nom	Type	Description	Obligatoire
name	chaîne	Obtient ou définit le nom de l'ingestion.	Non
état	chaîne	Obtient ou définit l’état de l'ingestion. Énumération : "notStarted", , "completed""running", "failed","partiallySucceeded"	Non
error	ErrorResponseDetails		Non
batchName	string	Le nom du lot associé à cette ingestion.	Non
createdDateTime	dateTime	Obtient ou définit la date et l’heure de création de l’ingestion.	Non
lastModifiedDateTime	dateTime	Obtient ou définit la date et l’heure de dernière modification de l’ingestion.	Non
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	La liste de statuts d’ingestion pour chaque document.	Non

IngestionResponseModelCollectionApiModel

Contient un tableau de résultats pouvant être paginés.

Nom	Type	Description	Obligatoire
value	[ IngestionResponseModel ]	Le tableau de résultats.	Oui
nextLink	string	Un lien vers le groupe suivant de résultats paginés, s’il y a d’autres résultats disponibles; non présent dans le cas contraire.	Non

IngestionStatusDetailsApiModel

Représente les informations d’état d’ingestion pour chaque document.

Nom	Type	Description	Obligatoire
lastUpdateTime	dateTime	Heure de mise à jour de l’état du bloc de lots.	Oui
documentId	string	ID du document.	Oui
documentUrl	chaîne (uri)	L’url du document.	Non
succeeded	boolean	Un indicateur indiquant si l’inférence a réussi.	Oui
error	IngestionErrorDetailsApiModel		Non

MetadataSchemaFieldModel

Représente un champ dans le schéma de métadonnées.

Nom	Type	Description	Obligatoire
name	chaîne	Obtient ou définit le nom du champ.	Oui
peut faire l’objet d’une recherche	boolean	Obtient ou définit une valeur indiquant si le champ peut être recherché.	Oui
filterable	boolean	Obtient ou définit une valeur indiquant si le champ peut être filtré.	Oui
type	string	Obtient ou définit le type du champ. Il peut s’agir d’une chaîne ou d’une dateheure. Énumération : "string", "datetime"	Oui

MetadataSchemaModel

Représente le schéma de métadonnées pour le document.

Nom	Type	Description	Obligatoire
langue	string	Obtient ou définit le langage du schéma de métadonnées. La valeur par défaut est « en ».	Non
fields	[ MetadataSchemaFieldModel ]	Obtient ou définit la liste des champs dans le schéma de métadonnées.	Oui

SearchFiltersModel

Représente les filtres à appliquer sur une requête de recherche.

Nom	Type	Description	Obligatoire
stringFilters	[ StringFilterModel ]	Obtient ou définit les filtres de chaîne à appliquer sur la requête de recherche.	Non
datetimeFilters	[ DatetimeFilterModel ]	Obtient ou définit les filtres de dateheure à appliquer sur la requête de recherche.	Non
featureFilters	[ string ]	Obtient ou définit les filtres de fonctionnalités à appliquer sur la requête de recherche.	Non

SearchQueryTextRequestModel

Représente un modèle de demande de requête de recherche pour la recherche textuelle.

Nom	Type	Description	Obligatoire
queryText	string	Obtient ou définit le texte de la requête.	Oui
filters	SearchFiltersModel		Non
modération	boolean	Obtient ou définit une valeur booléenne qui indique si la modération est activée ou désactivée.	Non
haut	entier	Obtient ou définit le nombre de résultats à récupérer.	Oui
skip	entier	Obtient ou définit le nombre de résultats à sauter.	Oui
additionalIndexNames	[ string ]	Obtient ou définit les noms d’index supplémentaires à inclure dans la requête de recherche.	Non
dedup	boolean	Indique s’il faut supprimer les images vidéo similaires.	Oui
dedupMaxDocumentCount	entier	Le nombre maximum de documents après une dédup.	Oui
disableMetadataSearch	boolean	Obtient ou définit une valeur booléenne indiquant si les métadonnées sont désactivées dans la recherche ou non.	Oui

SearchResultDocumentModel

Représente une réponse de requête de recherche.

Nom	Type	Description	Obligatoire
documentId	string	Obtient ou définit l’ID du document.	Non
documentKind	string	Obtient ou définit le type du document, qui peut être « vidéo ».	Non
start	string	Obtient ou définit l'heure de début du document. Cette propriété s'applique uniquement aux documents vidéo.	Non
end	string	Obtient ou définit l’heure de fin du document. Cette propriété s'applique uniquement aux documents vidéo.	Non
meilleur	string	Obtient ou définit l’horodatage du document avec le score de pertinence le plus élevé. Cette propriété s'applique uniquement aux documents vidéo.	Non
relevance	double	Obtient ou définit le score de pertinence du document.	Oui
additionalMetadata	object	Obtient ou définit les métadonnées supplémentaires associées à la recherche.	Non

SearchResultDocumentModelCollectionApiModel

Contient un tableau de résultats pouvant être paginés.

Nom	Type	Description	Obligatoire
value	[ SearchResultDocumentModel ]	Le tableau de résultats.	Oui
nextLink	string	Un lien vers le groupe suivant de résultats paginés, s’il y a d’autres résultats disponibles; non présent dans le cas contraire.	Non

StringFilterModel

Représente un filtre de chaîne à appliquer à une requête de recherche.

Nom	Type	Description	Obligatoire
fieldName	string	Obtient ou définit le nom de la propriété à filtrer.	Oui
.	[ string ]	Obtient ou définit les valeurs à filtrer.	Oui

UpdateIngestionIndexRequestModel

Représente le modèle de requête de mise à jour d’index d’ingestion pour le document JSON.

Nom	Type	Description	Obligatoire
metadataSchema	MetadataSchemaModel		Non
userData	object	Obtient ou définit les données utilisateur pour le document.	Non