Videoabruf-API-Referenz

Authentifizierung

Fügen Sie die folgenden Header ein, wenn Sie einen Aufruf an eine beliebige API in diesem Dokument ausführen.

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

CreateIndex

URL

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

Beschreibung

Diese Methode erstellt einen Index, der dann zum Erfassen von Dokumenten verwendet werden kann. Ein Index muss erstellt werden, bevor die Erfassung durchgeführt werden kann.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des zu erstellenden Indexes.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge
body	body	Der Anforderungstext, der die Metadaten enthält, die für die Suche verwendet werden können.	Ja	CreateIngestionIndexRequestModel

Antworten

Code	Beschreibung	type
201	Erstellt	GetIngestionIndexResponseModel

GetIndex

URL

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

Beschreibung

Ruft den Index mit dem angegebenen Namen ab.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des abzurufenden Indexes.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge

Antworten

Code	Beschreibung	type
200	Erfolg	GetIngestionIndexResponseModel
default	Fehler	ErrorResponse

UpdateIndex

URL

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

Beschreibung

Aktualisiert einen Index mit dem angegebenen Namen.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des zu aktualisierenden Indexes.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge
body	body	Der Anforderungstext, der die Aktualisierungen enthält, die auf den Index angewendet werden sollen.	Ja	UpdateIngestionIndexRequestModel

Antworten

Code	Beschreibung	type
200	Erfolg	GetIngestionIndexResponseModel
default	Fehler	ErrorResponse

DeleteIndex

URL

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

Beschreibung

Löscht einen Index und alle zugehörigen Erfassungsdokumente.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des zu löschenden Indexes.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge

Antworten

Code	BESCHREIBUNG
204	Kein Inhalt

ListIndexes

URL

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

Beschreibung

Ruft eine Liste aller Indizes für alle Erfassungen ab.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
$skip	Abfrage	Anzahl der zu überspringenden Datasets.	Nein	integer
$top	Abfrage	Die Anzahl der Datasets, die nach dem Überspringen zurückgegeben werden sollen.	Nein	integer
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge

Antworten

Code	Beschreibung	type
200	Erfolg	GetIngestionIndexResponseModelCollectionApiModel
default	Fehler	ErrorResponse

CreateIngestion

URL

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

Beschreibung

Die Erfassungsanforderung kann Videonutzlast haben. Er kann einen der drei Modi aufweisen (Hinzufügen, Aktualisieren oder Entfernen). Der Add-Modus erstellt eine Erfassung und verarbeitet das Video. Der Aktualisierungsmodus aktualisiert nur die Metadaten. Um das Video erneut zu verarbeiten, muss die Erfassung gelöscht und neu erstellt werden.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des Indexes, in den die Erfassung erstellt werden soll.	Ja	Zeichenfolge
ingestionName	path	Der Name der zu erstellenden Erfassung.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge
body	body	Der Anforderungstext, der die zu erstellende Erfassungsanforderung enthält.	Ja	CreateIngestionRequestModel

Antworten

Code	Beschreibung	type
202	Akzeptiert	IngestionResponseModel

GetIngestion

URL

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

Beschreibung

Ruft den Erfassungsstatus für den angegebenen Index- und Erfassungsnamen ab.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des Indexes, für den der Erfassungsstatus überprüft werden soll.	Ja	Zeichenfolge
ingestionName	path	Der Name der abzurufenden Erfassung.	Ja	Zeichenfolge
detailLevel	Abfrage	Eine Ebene, die die Detailebene pro Dokumenterfassungsstatus angibt.	Nein	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge

Antworten

Code	Beschreibung	type
200	Erfolg	IngestionResponseModel
default	Fehler	ErrorResponse

ListIngestions

URL

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

Beschreibung

Ruft alle Erfassungen für den spezifischen Index ab.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des Indexes, für den die Erfassung abgerufen werden soll.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge

Antworten

Code	Beschreibung	type
200	Erfolg	IngestionResponseModelCollectionApiModel
default	Fehler	ErrorResponse

ListDocuments

URL

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

Beschreibung

Ruft alle Dokumente für den spezifischen Index ab.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des Indexes, für den die Dokumente abgerufen werden sollen.	Ja	Zeichenfolge
$skip	Abfrage	Anzahl der zu überspringenden Datasets.	Nein	integer
$top	Abfrage	Die Anzahl der Datasets, die nach dem Überspringen zurückgegeben werden sollen.	Nein	integer
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge

Antworten

Code	Beschreibung	type
200	Erfolg	IngestionDocumentResponseModelCollectionApiModel
default	Fehler	ErrorResponse

SearchByText

URL

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

Beschreibung

Führt eine textbasierte Suche für den angegebenen Index aus.

Parameter

Name	Enthalten in	Beschreibung	Erforderlich	type
indexName	path	Der Name des neu zu erstellenden Indexes.	Ja	Zeichenfolge
api-version	Abfrage	Angeforderte API-Version.	Ja	Zeichenfolge
body	body	Der Anforderungstext, der die Abfrage und andere Parameter enthält.	Ja	SearchQueryTextRequestModel

Antworten

Code	Beschreibung	type
200	Erfolg	SearchResultDocumentModelCollectionApiModel
default	Fehler	ErrorResponse

Modelle

CreateIngestionIndexRequestModel

Stellt das Anforderungsmodell für das JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
metadataSchema	MetadataSchemaModel		Nein
Features	[ FeatureModel ]	Ruft die Liste der Features für das Dokument ab oder legt sie fest. Der Standardwert ist „Vision“.	Nein
userData	Objekt	Ruft die Benutzerdaten für das Dokument ab oder legt sie fest.	Nein

CreateIngestionRequestModel

Stellt das Anforderungsmodell zum Erstellen der Erfassung für das JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
Videos	[ IngestionDocumentRequestModel ]	Ruft die Liste der Erfassungsanforderungen für Videodokument im JSON-Dokument ab oder legt sie fest.	Nein
Moderation	boolean	Ruft ab oder legt das Moderationskennzeichnung fest, der angibt, ob der Inhalt moderiert werden soll.	Nein
generateInsightIntervals	boolean	Dient zum Abrufen oder Festlegen des Intervallgenerierungskennzeichen, das angibt, ob Erfassungsintervalle generiert werden sollen.	Nein
documentAuthenticationKind	Zeichenfolge	Dient zum Abrufen oder Festlegen der Authentifizierungsart, die zum Herunterladen der Dokumente verwendet werden soll. Enumeration: "none", "managedIdentity"	No
filterDefectedFrames	boolean	Framefilterkennzeichnung, die angibt, dass Frames ausgewertet werden, und alle defekten (z. B. unscharfe, geringe Beleuchtung, überbelichteten) Frames werden herausgefiltert.	Nein
includeSpeechTranscript	boolean	Dient zum Abrufen oder Festlegen des Transkriptgenerierungsflags, das angibt, ob ein Transkript generiert werden soll.	Nein

DatetimeFilterModel

Stellt einen Datetime-Filter dar, der für eine Suchabfrage angewendet werden soll.

Name	Typ	Beschreibung	Erforderlich
fieldName	Zeichenfolge	Dient zum Abrufen oder Festlegen des Namens des Felds, nach dem gefiltert werden soll.	Ja
startTime	Zeichenfolge	Dient zum Abrufen oder Festlegen der Startzeit des Bereichs, nach dem gefiltert werden soll.	Nein
endTime	Zeichenfolge	Dient zum Abrufen oder Festlegen der Endzeit des Bereichs, nach dem gefiltert werden soll.	Nein

ErrorResponse

Antwort, die zurückgegeben wird, wenn ein Fehler auftritt.

Name	Typ	Beschreibung	Erforderlich
error	ErrorResponseDetails		Ja

ErrorResponseDetails

Fehlerinformationen.

Name	Typ	Beschreibung	Erforderlich
code	Zeichenfolge	Fehlercode	Ja
message	Zeichenfolge	Fehlermeldung.	Ja
target	Zeichenfolge	Das Ziel des Fehlers.	Nein
details	[ ErrorResponseDetails ]	Liste der detaillierten Fehler.	Nein
innererror	ErrorResponseInnerError		Nein

ErrorResponseInnerError

Detaillierter Fehler.

Name	Typ	Beschreibung	Erforderlich
code	Zeichenfolge	Fehlercode	Ja
message	Zeichenfolge	Fehlermeldung.	Ja
innererror	ErrorResponseInnerError		Nein

FeatureModel

Stellt ein Feature im Index dar.

Name	Typ	Beschreibung	Erforderlich
name	Zeichenfolge	Ruft den Namen der Feature ab oder legt ihn fest. Enumeration: "vision", "speech"	Ja
modelVersion	Zeichenfolge	Ruft die Modellversion des Features ab oder legt sie fest.	Nein
Domäne	Zeichenfolge	Ruft die Modelldomäne des Features ab oder legt sie fest. Enumeration: "generic", "surveillance"	No

GetIngestionIndexResponseModel

Stellt das Antwortmodell für den Abrufindex für das JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
name	Zeichenfolge	Ruft den Indexnamen ab oder legt ihn fest.	Nein
metadataSchema	MetadataSchemaModel		Nein
userData	Objekt	Ruft die Benutzerdaten für das Dokument ab oder legt sie fest.	Nein
Features	[ FeatureModel ]	Ruft die Liste der Features im Index ab oder legt sie fest.	Nein
eTag	Zeichenfolge	Ruft den ETag ab oder legt ihn fest.	Ja
createdDateTime	dateTime	Ruft die erstellte Datums- und Uhrzeiteigenschaft ab oder legt sie fest.	Ja
lastModifiedDateTime	dateTime	Dient zum Abrufen oder Festlegen der letzten bearbeiteten Eigenschaft „Datum und Uhrzeit“.	Ja

GetIngestionIndexResponseModelCollectionApiModel

Enthält ein Array von Ergebnissen, die möglicherweise paginiert werden.

Name	Typ	Beschreibung	Erforderlich
value	[ GetIngestionIndexResponseModel ]	Das Array der Ergebnisse.	Ja
nextLink	Zeichenfolge	Eine Verknüpfung mit dem nächsten Satz von paginierten Ergebnissen, wenn weitere Ergebnisse verfügbar sind; andernfalls nicht vorhanden.	Nein

IngestionDocumentRequestModel

Stellt eine Videodokumenterfassungsanforderung im JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
Modus	Zeichenfolge	Dient zum Abrufen oder Festlegen des Modus der Erfassung für das Dokument. Enumeration: "add", "update""remove"	Ja
documentId	Zeichenfolge	Ruft die Dokument-ID ab oder legt diese fest.	Nein
documentUrl	Zeichenfolge (URI)	Ruft die Dokument-URL ab oder legt diese fest. Freigegebene Zugriffssignatur (SHARED Access Signature, SAS), falls vorhanden, wird aus der URL entfernt.	Ja
metadata	Objekt	Dient zum Abrufen oder Festlegen der Metadaten für das Dokument als Wörterbuch mit Name/Wert-Paaren.	Nein
userData	Objekt	Ruft die Benutzerdaten für das Dokument ab oder legt sie fest.	Nein

IngestionDocumentResponseModel

Stellt ein Erfassungsdokumentantwortobjekt im JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
documentId	Zeichenfolge	Ruft die Dokument-ID ab oder legt diese fest.	Nein
documentUrl	Zeichenfolge (URI)	Ruft die Dokument-URL ab oder legt diese fest. Freigegebene Zugriffssignatur (SHARED Access Signature, SAS), falls vorhanden, wird aus der URL entfernt.	Nein
metadata	Objekt	Dient zum Abrufen oder Festlegen der Schlüssel-Wert-Paare von Metadaten.	Nein
error	ErrorResponseDetails		Nein
createdDateTime	dateTime	Dient zum Abrufen oder Festlegen des Erstellungsdatums und der Erstellungszeit des Dokuments.	Nein
lastModifiedDateTime	dateTime	Dient zum Abrufen oder Festlegen des Datums und der Uhrzeit der letzten Änderung des Dokuments.	Nein
userData	Objekt	Ruft die Benutzerdaten für das Dokument ab oder legt sie fest.	Nein

IngestionDocumentResponseModelCollectionApiModel

Enthält ein Array von Ergebnissen, die möglicherweise paginiert werden.

Name	Typ	Beschreibung	Erforderlich
value	[ IngestionDocumentResponseModel ]	Das Array der Ergebnisse.	Ja
nextLink	Zeichenfolge	Eine Verknüpfung mit dem nächsten Satz von paginierten Ergebnissen, wenn weitere Ergebnisse verfügbar sind; andernfalls nicht vorhanden.	Nein

IngestionErrorDetailsApiModel

Stellt die Erfassungsfehlerinformationen für jedes Dokument dar.

Name	Typ	Beschreibung	Erforderlich
code	Zeichenfolge	Fehlercode	Nein
message	Zeichenfolge	Fehlermeldung.	Nein
innerError	IngestionInnerErrorDetailsApiModel		Nein

IngestionInnerErrorDetailsApiModel

Stellt die internen Fehlerinformationen für die Erfassung für jedes Dokument dar.

Name	Typ	Beschreibung	Erforderlich
code	Zeichenfolge	Fehlercode	Nein
message	Zeichenfolge	Fehlermeldung.	Nein
innerError	IngestionInnerErrorDetailsApiModel		Nein

IngestionResponseModel

Stellt das Erfassungsantwortmodell für das JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
name	Zeichenfolge	Ruft den Namen der Instanz ab oder legt ihn fest.	Nein
state	Zeichenfolge	Ruft den Status des Parameters ab oder legt ihn fest. Enumeration: "notStarted", , "running""completed", , "failed""partiallySucceeded"	No
error	ErrorResponseDetails		Nein
batchName	Zeichenfolge	Der Name des Batches, der dieser Erfassung zugeordnet ist.	Nein
createdDateTime	dateTime	Dient zum Abrufen oder Festlegen des Erstellungsdatums und der Uhrzeit der Erfassung.	Nein
lastModifiedDateTime	dateTime	Dient zum Abrufen oder Festlegen des Datums und der Uhrzeit der letzten Änderung der Erfassung.	Nein
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	Die Liste der Erfassungsstatus für jedes Dokument.	Nein

IngestionResponseModelCollectionApiModel

Enthält ein Array von Ergebnissen, die möglicherweise paginiert werden.

Name	Typ	Beschreibung	Erforderlich
value	[ IngestionResponseModel ]	Das Array der Ergebnisse.	Ja
nextLink	Zeichenfolge	Eine Verknüpfung mit dem nächsten Satz von paginierten Ergebnissen, wenn weitere Ergebnisse verfügbar sind; andernfalls nicht vorhanden.	Nein

IngestionStatusDetailsApiModel

Stellt die Details des Erfassungstatus für jedes Dokument dar.

Name	Typ	Beschreibung	Erforderlich
lastUpdateTime	dateTime	Statusaktualisierungszeit des Batchabschnitts.	Ja
documentId	Zeichenfolge	Dokument-ID	Ja
documentUrl	Zeichenfolge (URI)	Die URL des Dokuments.	Nein
succeeded	boolean	Ein Kennzeichen, das angibt, ob die Erfassung erfolgreich war.	Ja
error	IngestionErrorDetailsApiModel		Nein

MetadataSchemaFieldModel

Stellt ein Feld im Metadatenschema dar.

Name	Typ	Beschreibung	Erforderlich
name	Zeichenfolge	Ruft den Namen des Felds ab oder legt ihn fest.	Ja
searchable	boolean	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Feld durchsuchbar ist.	Ja
filterable	boolean	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob das Feld gefiltert werden kann.	Ja
Typ	Zeichenfolge	Ruft den Indextyp ab oder legt ihn fest. Es kann sich um eine Zeichenfolge oder datetime sein. Enumeration: "string", "datetime"	Ja

MetadataSchemaModel

Stellt das Metadatenschema für das Dokument dar.

Name	Typ	Beschreibung	Erforderlich
Sprache	Zeichenfolge	Ruft die Sprache des Metadatenschemas ab oder legt sie fest. Der Standardwert ist „en“.	Nein
felder	[ MetadataSchemaFieldModel ]	Ruft die Liste der Felder im Metadatenschema ab oder legt sie fest.	Ja

SearchFiltersModel

Stellt die Filter dar, die auf eine Suchabfrage angewendet werden sollen.

Name	Typ	Beschreibung	Erforderlich
stringFilters	[ StringFilterModel ]	Dient zum Abrufen oder Festlegen der Zeichenfolgenfilter, die für die Suchabfrage angewendet werden sollen.	Nein
datetimeFilters	[ DatetimeFilterModel ]	Ruft die datetime-Filter ab, die für die Suchabfrage angewendet werden sollen, oder legt diese fest.	Nein
featureFilters	[ Zeichenfolge ]	Ruft die Funktionsfilter ab, die für die Suchabfrage angewendet werden sollen, oder legt diese fest.	Nein

SearchQueryTextRequestModel

Stellt ein Suchabfrageanforderungsmodell für die textbasierte Suche dar.

Name	Typ	Beschreibung	Erforderlich
queryText	Zeichenfolge	Ruft den Abfragetext ab oder legt ihn fest.	Ja
filters	SearchFiltersModel		Nein
Moderation	boolean	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Moderation aktiviert oder deaktiviert ist.	Nein
Oben	integer	Ruft die Anzahl der abzurufenden Ergebnisse ab oder legt sie fest.	Ja
skip	integer	Ruft die Anzahl der zu überspringenden Ergebnisse ab oder legt sie fest.	Ja
additionalIndexNames	[ Zeichenfolge ]	Ruft die zusätzlichen Indexnamen ab, die in die Suchabfrage eingeschlossen werden sollen, oder legt sie fest.	Nein
dedup	boolean	Gibt an, ob ähnliche Videoframes entfernt werden sollen.	Ja
dedupMaxDocumentCount	integer	Die maximale Anzahl von Dokumenten nach dedup.	Ja
disableMetadataSearch	boolean	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob Metadaten in der Suche deaktiviert sind oder nicht.	Ja

SearchResultDocumentModel

Stellt eine Suchabfrageantwort dar.

Name	Typ	Beschreibung	Erforderlich
documentId	Zeichenfolge	Ruft die ID der Version ab oder legt sie fest.	Nein
documentKind	Zeichenfolge	Dient zum Abrufen oder Festlegen der Art des Dokuments, das „Video“ sein kann.	Nein
start	Zeichenfolge	Ruft die Startzeit der Startzeit des Dokuments ab oder legt sie fest. Diese Eigenschaft gilt nur für Videodokumente.	Nein
end	Zeichenfolge	Ruft die Endzeit der Sitzung ab oder legt sie fest. Diese Eigenschaft gilt nur für Videodokumente.	Nein
test	Zeichenfolge	Dient zum Abrufen oder Festlegen des Zeitstempels des Dokuments mit dem höchsten Relevanzscore. Diese Eigenschaft gilt nur für Videodokumente.	Nein
relevance	double	Ruft die Relevanzbewertung des Dokuments ab oder legt diese fest.	Ja
additionalMetadata	Objekt	Dient zum Abrufen oder Festlegen der zusätzlichen Metadaten im Zusammenhang mit der Suche.	Nein

SearchResultDocumentModelCollectionApiModel

Enthält ein Array von Ergebnissen, die möglicherweise paginiert werden.

Name	Typ	Beschreibung	Erforderlich
value	[ SearchResultDocumentModel ]	Das Array der Ergebnisse.	Ja
nextLink	Zeichenfolge	Eine Verknüpfung mit dem nächsten Satz von paginierten Ergebnissen, wenn weitere Ergebnisse verfügbar sind; andernfalls nicht vorhanden.	Nein

StringFilterModel

Stellt einen Zeichenfolgenfilter dar, der für eine Suchabfrage angewendet werden soll.

Name	Typ	Beschreibung	Erforderlich
fieldName	Zeichenfolge	Dient zum Abrufen oder Festlegen des Namens des Felds, nach dem gefiltert werden soll.	Ja
values	[ Zeichenfolge ]	Ruft die zu filternden Werte ab oder legt sie fest.	Ja

UpdateIngestionIndexRequestModel

Stellt das Aktualisierungsindexanforderungsmodell für das JSON-Dokument dar.

Name	Typ	Beschreibung	Erforderlich
metadataSchema	MetadataSchemaModel		Nein
userData	Objekt	Ruft die Benutzerdaten für das Dokument ab oder legt sie fest.	Nein