Naslaginformatie over de API voor het ophalen van video's

Verificatie

Neem de volgende headers op bij het aanroepen van een API in dit document.

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

CreateIndex

URL

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

Beschrijving

Met deze methode maakt u een index, die vervolgens kan worden gebruikt om documenten op te nemen. Er moet een index worden gemaakt voordat opname kan worden uitgevoerd.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index die moet worden gemaakt.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks
hoofdtekst	hoofdtekst	De hoofdtekst van de aanvraag met de metagegevens die kunnen worden gebruikt voor het zoeken.	Ja	CreateIngestionIndexRequestModel

Antwoorden

Code	Description	Type
201	Gemaakt	GetIngestionIndexResponseModel

GetIndex

URL

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

Beschrijving

Haalt de index op met de opgegeven naam.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index die moet worden opgehaald.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks

Antwoorden

Code	Description	Type
200	Voltooid	GetIngestionIndexResponseModel
default	Error	ErrorResponse

UpdateIndex

URL

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

Beschrijving

Hiermee werkt u een index bij met de opgegeven naam.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index die moet worden bijgewerkt.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks
hoofdtekst	hoofdtekst	De aanvraagbody met de updates die moeten worden toegepast op de index.	Ja	UpdateIngestionIndexRequestModel

Antwoorden

Code	Description	Type
200	Voltooid	GetIngestionIndexResponseModel
default	Error	ErrorResponse

DeleteIndex

URL

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

Beschrijving

Hiermee verwijdert u een index en alle bijbehorende opnamedocumenten.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index die moet worden verwijderd.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks

Antwoorden

Code	Beschrijving
204	Geen inhoud

ListIndexes

URL

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

Beschrijving

Hiermee haalt u een lijst met alle indexen op voor alle opnamebewerkingen.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
$skip	query	Het aantal gegevenssets dat moet worden overgeslagen.	Nee	geheel getal
$top	query	Het aantal gegevenssets dat moet worden geretourneerd na het overslaan.	Nee	geheel getal
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks

Antwoorden

Code	Description	Type
200	Voltooid	GetIngestionIndexResponseModelCollectionApiModel
default	Error	ErrorResponse

CreateIngestion

URL

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

Beschrijving

Opnameaanvraag kan videolading hebben. Het kan een van de drie modi hebben (toevoegen, bijwerken of verwijderen). De modus Toevoegen maakt een opname en verwerkt de video. De updatemodus werkt alleen de metagegevens bij. Als u de video opnieuw wilt verwerken, moet de opname worden verwijderd en opnieuw worden gemaakt.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index waarop de opname moet worden gemaakt.	Ja	tekenreeks
opnamenaam	path	De naam van de opname die moet worden gemaakt.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks
hoofdtekst	hoofdtekst	De aanvraagbody met de opnameaanvraag die moet worden gemaakt.	Ja	CreateIngestionRequestModel

Antwoorden

Code	Description	Type
202	Geaccepteerd	IngestionResponseModel

GetIngestion

URL

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

Beschrijving

Hiermee haalt u de opnamestatus op voor de opgegeven index en opnamenaam.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index waarvoor de opnamestatus moet worden gecontroleerd.	Ja	tekenreeks
opnamenaam	path	De naam van de opname die moet worden opgehaald.	Ja	tekenreeks
detailLevel	query	Een niveau om het detailniveau per documentopnamestatus aan te geven.	Nee	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks

Antwoorden

Code	Description	Type
200	Voltooid	IngestionResponseModel
default	Error	ErrorResponse

ListIngestions

URL

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

Beschrijving

Hiermee worden alle opnamebewerkingen voor de specifieke index opgehaald.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index waarvoor de opname moet worden opgehaald.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks

Antwoorden

Code	Description	Type
200	Voltooid	IngestionResponseModelCollectionApiModel
default	Error	ErrorResponse

ListDocuments

URL

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

Beschrijving

Haalt alle documenten voor de specifieke index op.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index waarvoor de documenten moeten worden opgehaald.	Ja	tekenreeks
$skip	query	Het aantal gegevenssets dat moet worden overgeslagen.	Nee	geheel getal
$top	query	Het aantal gegevenssets dat moet worden geretourneerd na het overslaan.	Nee	geheel getal
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks

Antwoorden

Code	Description	Type
200	Voltooid	OpnameDocumentResponseModelCollectionApiModel
default	Error	ErrorResponse

SearchByText

URL

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

Beschrijving

Voert een zoekopdracht op basis van tekst uit op de opgegeven index.

Parameters

Naam	Gelegen in	Beschrijving	Vereist	Type
indexName	path	De naam van de index die moet worden gezocht.	Ja	tekenreeks
api-versie	query	Aangevraagde API-versie.	Ja	tekenreeks
hoofdtekst	hoofdtekst	De aanvraagbody met de query en andere parameters.	Ja	SearchQueryTextRequestModel

Antwoorden

Code	Description	Type
200	Voltooid	SearchResultDocumentModelCollectionApiModel
default	Error	ErrorResponse

Modellen

CreateIngestionIndexRequestModel

Vertegenwoordigt het aanvraagmodel voor het maken van opname-indexen voor het JSON-document.

Name	Type	Beschrijving	Vereist
metadataSchema	MetadataSchemaModel		Nee
features	[ FeatureModel ]	Hiermee haalt u de lijst met functies voor het document op of stelt u deze in. De standaardwaarde is 'vision'.	Nee
Userdata	object	Hiermee worden de gebruikersgegevens voor het document opgehaald of ingesteld.	Nee

CreateIngestionRequestModel

Vertegenwoordigt het aanvraagmodel voor opname maken voor het JSON-document.

Name	Type	Beschrijving	Vereist
Video 's	[ IngestionDocumentRequestModel ]	Hiermee haalt u de lijst met opnameaanvragen voor videodocument op of stelt u deze in het JSON-document in.	Nee
moderatie	boolean	Hiermee wordt de toezichtsvlag opgehaald of ingesteld, waarmee wordt aangegeven of de inhoud moet worden gemodereerd.	Nee
generateInsightIntervals	boolean	Hiermee haalt u de vlag voor het genereren van het interval op of stelt u deze in, waarmee wordt aangegeven of er inzichtintervallen moeten worden gegenereerd.	Nee
documentAuthenticationKind	tekenreeks	Hiermee haalt u het verificatietype op dat moet worden gebruikt voor het downloaden van de documenten. Opsomming:"none", "managedIdentity"	Nee
filterDefectedFrames	boolean	Framefiltervlag die aangeeft dat frames worden geëvalueerd en alle defecte frames (bijvoorbeeld wazig, laaglicht, overbelicht) worden uitgefilterd.	Nee
includeSpeechTranscript	boolean	Hiermee wordt de vlag voor het genereren van transcripten opgevraagd of ingesteld, waarmee wordt aangegeven of transcriptie moet worden gegenereerd.	Nee

DatetimeFilterModel

Vertegenwoordigt een datum/tijd-filter dat moet worden toegepast op een zoekquery.

Name	Type	Beschrijving	Vereist
Veldnaam	tekenreeks	Hiermee wordt de naam van het veld opgehaald of ingesteld waarop moet worden gefilterd.	Ja
startTime	tekenreeks	Hiermee haalt u de begintijd van het bereik op of stelt u deze in om op te filteren.	Nee
endTime	tekenreeks	Hiermee haalt u de eindtijd van het bereik op of stelt u deze in om op te filteren.	Nee

ErrorResponse

Antwoord geretourneerd wanneer er een fout optreedt.

Name	Type	Beschrijving	Vereist
error	ErrorResponseDetails		Ja

ErrorResponseDetails

Foutinformatie.

Name	Type	Beschrijving	Vereist
code	tekenreeks	Foutcode.	Ja
bericht	tekenreeks	Foutbericht.	Ja
doel	tekenreeks	Doel van de fout.	Nee
details	[ ErrorResponseDetails ]	Lijst met gedetailleerde fouten.	Nee
innererror	ErrorResponseInnerError		Nee

ErrorResponseInnerError

Gedetailleerde fout.

Name	Type	Beschrijving	Vereist
code	tekenreeks	Foutcode.	Ja
bericht	tekenreeks	Foutbericht.	Ja
innererror	ErrorResponseInnerError		Nee

FeatureModel

Vertegenwoordigt een functie in de index.

Name	Type	Beschrijving	Vereist
naam	tekenreeks	Hiermee haalt u de naam van de functie op of stelt u deze in. Opsomming:"vision", "speech"	Ja
modelVersion	tekenreeks	Hiermee haalt u de modelversie van de functie op of stelt u deze in.	Nee
domain	tekenreeks	Hiermee haalt u het modeldomein van de functie op of stelt u deze in. Opsomming:"generic", "surveillance"	Nee

GetIngestionIndexResponseModel

Vertegenwoordigt het antwoordmodel van de get-opnameindex voor het JSON-document.

Name	Type	Beschrijving	Vereist
naam	tekenreeks	Hiermee haalt u de eigenschap indexnaam op of stelt u deze in.	Nee
metadataSchema	MetadataSchemaModel		Nee
Userdata	object	Hiermee worden de gebruikersgegevens voor het document opgehaald of ingesteld.	Nee
features	[ FeatureModel ]	Hiermee haalt u de lijst met functies in de index op of stelt u deze in.	Nee
eTag	tekenreeks	Hiermee haalt u de etag op of stelt u deze in.	Ja
createdDateTime	dateTime	Hiermee haalt u de gemaakte datum- en tijdeigenschap op of stelt u deze in.	Ja
lastModifiedDateTime	dateTime	Hiermee haalt u de laatst gewijzigde datum- en tijdeigenschap op of stelt u deze in.	Ja

GetIngestionIndexResponseModelCollectionApiModel

Bevat een matrix met resultaten die kunnen worden gepagineerd.

Name	Type	Beschrijving	Vereist
waarde	[ GetIngestionIndexResponseModel ]	De matrix met resultaten.	Ja
nextLink	tekenreeks	Een koppeling naar de volgende set gepagineerde resultaten, als er meer resultaten beschikbaar zijn; anders niet aanwezig.	Nee

IngestionDocumentRequestModel

Vertegenwoordigt een opnameaanvraag voor videodocument in het JSON-document.

Name	Type	Beschrijving	Vereist
modus	tekenreeks	Hiermee haalt u de modus van de opname voor het document op of stelt u deze in. Opsomming:"add", , "update""remove"	Ja
documentId	tekenreeks	Hiermee haalt u de document-id op of stelt u deze in.	Nee
documentUrl	tekenreeks (URI)	Hiermee haalt u de document-URL op of stelt u deze in. Shared Access Signature (SAS), indien van toepassing, wordt verwijderd uit de URL.	Ja
metagegevens	object	Hiermee worden de metagegevens voor het document opgehaald of ingesteld als een woordenlijst met naam-waardeparen.	Nee
Userdata	object	Hiermee worden de gebruikersgegevens voor het document opgehaald of ingesteld.	Nee

OpnameDocumentResponseModel

Vertegenwoordigt een antwoordobject voor opnamedocument in het JSON-document.

Name	Type	Beschrijving	Vereist
documentId	tekenreeks	Hiermee haalt u de document-id op of stelt u deze in.	Nee
documentUrl	tekenreeks (URI)	Hiermee haalt u de document-URL op of stelt u deze in. Shared Access Signature (SAS), indien van toepassing, wordt verwijderd uit de URL.	Nee
metagegevens	object	Hiermee worden de sleutel-waardeparen van metagegevens opgehaald of ingesteld.	Nee
error	ErrorResponseDetails		Nee
createdDateTime	dateTime	Hiermee haalt u de gemaakte datum en tijd van het document op of stelt u deze in.	Nee
lastModifiedDateTime	dateTime	Hiermee haalt u de laatst gewijzigde datum en tijd van het document op of stelt u deze in.	Nee
Userdata	object	Hiermee worden de gebruikersgegevens voor het document opgehaald of ingesteld.	Nee

OpnameDocumentResponseModelCollectionApiModel

Bevat een matrix met resultaten die kunnen worden gepagineerd.

Name	Type	Beschrijving	Vereist
waarde	[ OpnameDocumentResponseModel ]	De matrix met resultaten.	Ja
nextLink	tekenreeks	Een koppeling naar de volgende set gepagineerde resultaten, als er meer resultaten beschikbaar zijn; anders niet aanwezig.	Nee

IngestionErrorDetailsApiModel

Vertegenwoordigt de informatie over de opnamefout voor elk document.

Name	Type	Beschrijving	Vereist
code	tekenreeks	Foutcode.	Nee
bericht	tekenreeks	Foutbericht.	Nee
innerError	IngestionInnerErrorDetailsApiModel		Nee

IngestionInnerErrorDetailsApiModel

Vertegenwoordigt de interne foutinformatie voor de opname voor elk document.

Name	Type	Beschrijving	Vereist
code	tekenreeks	Foutcode.	Nee
bericht	tekenreeks	Foutbericht.	Nee
innerError	IngestionInnerErrorDetailsApiModel		Nee

IngestionResponseModel

Vertegenwoordigt het antwoordmodel voor opname voor het JSON-document.

Name	Type	Beschrijving	Vereist
naam	tekenreeks	Hiermee haalt u de naam van de opname op of stelt u deze in.	Nee
staat	tekenreeks	Hiermee haalt u de status van de opname op of stelt u deze in. Opsomming:"notStarted", "running", "completed", , "failed""partiallySucceeded"	Nee
error	ErrorResponseDetails		Nee
batchName	tekenreeks	De naam van de batch die aan deze opname is gekoppeld.	Nee
createdDateTime	dateTime	Hiermee haalt u de gemaakte datum en tijd van de opname op of stelt u deze in.	Nee
lastModifiedDateTime	dateTime	Hiermee haalt u de laatst gewijzigde datum en tijd van de opname op of stelt u deze in.	Nee
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	De lijst met opnamestatussen voor elk document.	Nee

IngestionResponseModelCollectionApiModel

Bevat een matrix met resultaten die kunnen worden gepagineerd.

Name	Type	Beschrijving	Vereist
waarde	[ OpnameResponseModel ]	De matrix met resultaten.	Ja
nextLink	tekenreeks	Een koppeling naar de volgende set gepagineerde resultaten, als er meer resultaten beschikbaar zijn; anders niet aanwezig.	Nee

IngestionStatusDetailsApiModel

Vertegenwoordigt de details van de opnamestatus voor elk document.

Name	Type	Beschrijving	Vereist
lastUpdateTime	dateTime	Statusupdatetijd van het batchsegment.	Ja
documentId	tekenreeks	De document-id.	Ja
documentUrl	tekenreeks (URI)	De URL van het document.	Nee
Geslaagd	boolean	Een vlag om aan te geven of deductie is geslaagd.	Ja
error	IngestionErrorDetailsApiModel		Nee

MetadataSchemaFieldModel

Vertegenwoordigt een veld in het metagegevensschema.

Name	Type	Beschrijving	Vereist
naam	tekenreeks	Hiermee haalt u de naam van het veld op of stelt u deze in.	Ja
doorzoekbaar	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of het veld doorzoekbaar is.	Ja
filteren mogelijk	boolean	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of het veld filterbaar is.	Ja
type	tekenreeks	Hiermee wordt het type veld opgehaald of ingesteld. Dit kan een tekenreeks of datum/tijd zijn. Opsomming:"string", "datetime"	Ja

MetadataSchemaModel

Vertegenwoordigt het metagegevensschema voor het document.

Name	Type	Beschrijving	Vereist
taal	tekenreeks	Hiermee haalt u de taal van het metagegevensschema op of stelt u deze in. De standaardwaarde is 'en'.	Nee
velden	[ MetadataSchemaFieldModel ]	Hiermee haalt u de lijst met velden in het metagegevensschema op of stelt u deze in.	Ja

SearchFiltersModel

Vertegenwoordigt de filters die moeten worden toegepast op een zoekquery.

Name	Type	Beschrijving	Vereist
stringFilters	[ StringFilterModel ]	Hiermee haalt u de tekenreeksfilters op die moeten worden toegepast op de zoekquery.	Nee
datetimeFilters	[ DatetimeFilterModel ]	Hiermee haalt u de datum/tijd-filters op die moeten worden toegepast op de zoekquery.	Nee
featureFilters	[ tekenreeks ]	Hiermee haalt u de functiefilters op die moeten worden toegepast op de zoekquery.	Nee

SearchQueryTextRequestModel

Vertegenwoordigt een queryaanvraagmodel voor zoekopdrachten op basis van tekst.

Name	Type	Beschrijving	Vereist
queryTekst	tekenreeks	Hiermee haalt u de querytekst op of stelt u deze in.	Ja
filters	SearchFiltersModel		Nee
moderatie	boolean	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of de beoordeling is ingeschakeld of uitgeschakeld.	Nee
top	geheel getal	Hiermee wordt het aantal resultaten opgehaald of ingesteld.	Ja
skip	geheel getal	Hiermee wordt het aantal resultaten opgehaald of ingesteld dat moet worden overgeslagen.	Ja
additionalIndexNames	[ tekenreeks ]	Hiermee haalt u de aanvullende indexnamen op die moeten worden opgenomen in de zoekquery of stelt u deze in.	Nee
ontdubbeling	boolean	Of u vergelijkbare videoframes wilt verwijderen.	Ja
dedupMaxDocumentCount	geheel getal	Het maximum aantal documenten na ontdubbeling.	Ja
disableMetadataSearch	boolean	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of metagegevens zijn uitgeschakeld in de zoekopdracht of niet.	Ja

SearchResultDocumentModel

Vertegenwoordigt een antwoord op een zoekquery.

Name	Type	Beschrijving	Vereist
documentId	tekenreeks	Hiermee haalt u de id van het document op of stelt u deze in.	Nee
documentKind	tekenreeks	Hiermee haalt u het type document op of stelt u dit in, wat 'video' kan zijn.	Nee
starten	tekenreeks	Hiermee haalt u de begintijd van het document op of stelt u deze in. Deze eigenschap is alleen van toepassing op videodocumenten.	Nee
end	tekenreeks	Hiermee haalt u de eindtijd van het document op of stelt u deze in. Deze eigenschap is alleen van toepassing op videodocumenten.	Nee
Beste	tekenreeks	Hiermee wordt de tijdstempel van het document opgehaald of ingesteld met de hoogste relevantiescore. Deze eigenschap is alleen van toepassing op videodocumenten.	Nee
Relevantie	dubbel	Hiermee haalt u de relevantiescore van het document op of stelt u deze in.	Ja
additionalMetadata	object	Hiermee haalt u de aanvullende metagegevens op die betrekking hebben op zoeken of stelt u deze in.	Nee

SearchResultDocumentModelCollectionApiModel

Bevat een matrix met resultaten die kunnen worden gepagineerd.

Name	Type	Beschrijving	Vereist
waarde	[ SearchResultDocumentModel ]	De matrix met resultaten.	Ja
nextLink	tekenreeks	Een koppeling naar de volgende set gepagineerde resultaten, als er meer resultaten beschikbaar zijn; anders niet aanwezig.	Nee

StringFilterModel

Vertegenwoordigt een tekenreeksfilter dat moet worden toegepast op een zoekquery.

Name	Type	Beschrijving	Vereist
Veldnaam	tekenreeks	Hiermee wordt de naam van het veld opgehaald of ingesteld waarop moet worden gefilterd.	Ja
waarden	[ tekenreeks ]	Hiermee worden de waarden opgehaald of ingesteld waarop moet worden gefilterd.	Ja

UpdateIngestionIndexRequestModel

Vertegenwoordigt het aanvraagmodel voor de updateopname-index voor het JSON-document.

Name	Type	Beschrijving	Vereist
metadataSchema	MetadataSchemaModel		Nee
Userdata	object	Hiermee worden de gebruikersgegevens voor het document opgehaald of ingesteld.	Nee