Videólekérési API-referencia
Hitelesítés
A dokumentum bármely API-jának hívásához vegye fel a következő fejléceket.
Ocp-Apim-Subscription-Key: YOUR_COMPUTER_VISION_KEY
Verzió: 2023-05-01-preview
CreateIndex
URL-cím
PUT /retrieval/indexes/{indexName}?api-version=<version_number>
Leírás
Ez a metódus létrehoz egy indexet, amely aztán a dokumentumok betöltésére használható. A betöltési műveletek végrehajtása előtt létre kell hozni egy indexet.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | A létrehozandó index neve. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
törzs | törzs | A kereséshez használható metaadatokat tartalmazó kérelemtörzs. | Igen | CreateIngestionIndexRequestModel |
Válaszok
Kód | Leírás | Típus |
---|---|---|
201 | Létrehozva | GetIngestionIndexResponseModel |
GetIndex
URL-cím
GET /retrieval/indexes/{indexName}?api-version=<version_number>
Leírás
Lekéri az indexet a megadott névvel.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | A lekérni kívánt index neve. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | GetIngestionIndexResponseModel |
alapértelmezett | Hiba | ErrorResponse |
UpdateIndex
URL-cím
PATCH /retrieval/indexes/{indexName}?api-version=<version_number>
Leírás
Frissíti az indexet a megadott névvel.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | A frissíteni kívánt index neve. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
törzs | törzs | Az indexre alkalmazni kívánt frissítéseket tartalmazó kérelem törzse. | Igen | UpdateIngestionIndexRequestModel |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | GetIngestionIndexResponseModel |
alapértelmezett | Hiba | ErrorResponse |
DeleteIndex
URL-cím
DELETE /retrieval/indexes/{indexName}?api-version=<version_number>
Leírás
Törli az indexet és annak összes kapcsolódó betöltési dokumentumát.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | A törölni kívánt index neve. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
Válaszok
Kód | Leírás |
---|---|
204 | Nincs tartalom |
ListIndexes
URL-cím
GET /retrieval/indexes?api-version=<version_number>
Leírás
Lekéri az összes betöltési index listáját.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
$skip | Lekérdezés | Kihagyandó adathalmazok száma. | Nem | egész szám |
$top | Lekérdezés | A kihagyás után visszaadandó adathalmazok száma. | Nem | egész szám |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | GetIngestionIndexResponseModelCollectionApiModel |
alapértelmezett | Hiba | ErrorResponse |
CreateIngestion
URL-cím
PUT /retrieval/indexes/{indexName}/ingestions/{ingestionName}?api-version=<version_number>
Leírás
A betöltési kérelem videotartalmat tartalmazhat. A három mód (hozzáadás, frissítés vagy eltávolítás) egyikével rendelkezhet. A hozzáadási mód betöltést hoz létre, és feldolgozzák a videót. A frissítési mód csak a metaadatokat frissíti. A videó újrafeldolgozásához törölni kell a betöltési elemet, és újra létre kell hozni.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | Annak az indexnek a neve, amelyhez a betöltési elemet létre kell hozni. | Igen | húr |
ingestionName | ösvény | A létrehozandó betöltési folyamat neve. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
törzs | törzs | A létrehozandó betöltési kérelmet tartalmazó kérelemtörzs. | Igen | CreateIngestionRequestModel |
Válaszok
Kód | Leírás | Típus |
---|---|---|
202 | Elfogadva | IngestionResponseModel |
GetIngestion
URL-cím
GET /retrieval/indexes/{indexName}/ingestions/{ingestionName}?api-version=<version_number>
Leírás
Lekéri a megadott index és betöltési név betöltési állapotát.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | Annak az indexnek a neve, amelynek betöltési állapotát ellenőrizni szeretné. | Igen | húr |
ingestionName | ösvény | A beolvasandó betöltési adat neve. | Igen | húr |
detailLevel | Lekérdezés | A dokumentumbetöltési állapot részletességi szintjét jelző szint. | Nem | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | IngestionResponseModel |
alapértelmezett | Hiba | ErrorResponse |
ListIngestions
URL-cím
GET /retrieval/indexes/{indexName}/ingestions?api-version=<version_number>
Leírás
Lekéri az adott index összes betöltését.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | Annak az indexnek a neve, amelyhez le szeretné kérni a betöltéseket. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | IngestionResponseModelCollectionApiModel |
alapértelmezett | Hiba | ErrorResponse |
ListDocuments
URL-cím
GET /retrieval/indexes/{indexName}/documents?api-version=<version_number>
Leírás
Lekéri az adott index összes dokumentumát.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | Annak az indexnek a neve, amelyhez le szeretné kérni a dokumentumokat. | Igen | húr |
$skip | Lekérdezés | Kihagyandó adathalmazok száma. | Nem | egész szám |
$top | Lekérdezés | A kihagyás után visszaadandó adathalmazok száma. | Nem | egész szám |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | IngestionDocumentResponseModelCollectionApiModel |
alapértelmezett | Hiba | ErrorResponse |
SearchByText
URL-cím
POST /retrieval/indexes/{indexName}:queryByText?api-version=<version_number>
Leírás
Szöveges keresést hajt végre a megadott indexen.
Paraméterek
Név | A következő helyen található: | Leírás | Kötelező | Típus |
---|---|---|---|---|
indexNév | ösvény | A keresendő index neve. | Igen | húr |
api-verzió | Lekérdezés | Kért API-verzió. | Igen | húr |
törzs | törzs | A lekérdezést és más paramétereket tartalmazó kérelem törzse. | Igen | SearchQueryTextRequestModel |
Válaszok
Kód | Leírás | Típus |
---|---|---|
200 | Siker | SearchResultDocumentModelCollectionApiModel |
alapértelmezett | Hiba | ErrorResponse |
Modellek
CreateIngestionIndexRequestModel
A JSON-dokumentum betöltési index-kérési modelljét jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
metadataSchema | MetadataSchemaModel | Nem | |
features | [ FeatureModel ] | Lekéri vagy beállítja a dokumentum funkcióinak listáját. Az alapértelmezett érték a "vision". | Nem |
userData | object | Lekéri vagy beállítja a dokumentum felhasználói adatait. | Nem |
CreateIngestionRequestModel
A JSON-dokumentumhoz tartozó betöltési kérelemmodellt jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
Videók | [ IngestionDocumentRequestModel ] | Lekéri vagy beállítja a videodokumentum-betöltési kérelmek listáját a JSON-dokumentumban. | Nem |
moderálás | Logikai | Lekéri vagy beállítja a moderálási jelzőt, amely jelzi, hogy a tartalmat moderálásra kell-e helyezni. | Nem |
generateInsightIntervals | Logikai | Lekéri vagy beállítja az intervallumgenerálás jelzőt, amely jelzi, hogy létre kell-e hozni a megállapítási időközöket. | Nem |
documentAuthenticationKind | húr | Lekéri vagy beállítja a dokumentumok letöltéséhez használandó hitelesítési típust. Enumerálás: "none" , "managedIdentity" |
Nem |
filterDefectedFrames | Logikai | A képkockákat jelző keretszűrő-jelző kiértékelésre kerül, és az összes hibás (például homályos, gyenge fényű, túlexponált) keret ki lesz szűrve. | Nem |
includeSpeechTranscript | Logikai | Lekéri vagy beállítja az átiratgenerálás jelzőt, amely jelzi, hogy létre kell-e hozni az átiratot. | Nem |
DatetimeFilterModel
Egy keresési lekérdezésre alkalmazandó dátum/idő szűrőt jelöl.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
fieldName | húr | Lekéri vagy beállítja a szűrni kívánt mező nevét. | Igen |
startTime | húr | Lekéri vagy beállítja a szűrni kívánt tartomány kezdő időpontját. | Nem |
endTime | húr | Lekéri vagy beállítja annak a tartománynak a befejezési idejét, amelyen szűrni szeretne. | Nem |
ErrorResponse
Hiba esetén visszaadott válasz.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
error | ErrorResponseDetails | Igen |
ErrorResponseDetails
Hibainformációk.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
code | húr | Hibakód. | Igen |
üzenet | húr | Hibaüzenet. | Igen |
target | húr | A hiba célja. | Nem |
részletek | [ ErrorResponseDetails ] | A részletes hibák listája. | Nem |
innererror | ErrorResponseInnerError | Nem |
ErrorResponseInnerError
Részletes hiba.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
code | húr | Hibakód. | Igen |
üzenet | húr | Hibaüzenet. | Igen |
innererror | ErrorResponseInnerError | Nem |
FeatureModel
Az index egy funkcióját jelöli.
Név | Típus | Leírás | Szükséges |
---|---|---|---|
név | húr | Lekéri vagy beállítja a szolgáltatás nevét. Enumerálás: "vision" , "speech" |
Igen |
modelVersion | húr | Lekéri vagy beállítja a funkció modellverzióját. | Nem |
domain | húr | Lekéri vagy beállítja a szolgáltatás modelltartományát. Enumerálás: "generic" , "surveillance" |
Nem |
GetIngestionIndexResponseModel
A JSON-dokumentum betöltési indexének válaszmodellje.
Név | Típus | Leírás | Szükséges |
---|---|---|---|
név | húr | Lekéri vagy beállítja az indexnév tulajdonságot. | Nem |
metadataSchema | MetadataSchemaModel | Nem | |
userData | object | Lekéri vagy beállítja a dokumentum felhasználói adatait. | Nem |
features | [ FeatureModel ] | Lekéri vagy beállítja az index funkcióinak listáját. | Nem |
e-címke | húr | Lekéri vagy beállítja az etaget. | Igen |
createdDateTime | dateTime | Lekéri vagy beállítja a létrehozott dátum- és időtulajdonságot. | Igen |
lastModifiedDateTime | dateTime | Lekéri vagy beállítja az utolsó módosított dátum- és időtulajdonságot. | Igen |
GetIngestionIndexResponseModelCollectionApiModel
Többoldalas eredményeket tartalmazó tömböt tartalmaz.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
Érték | [ GetIngestionIndexResponseModel ] | Az eredmények tömbje. | Igen |
nextLink | húr | A lapszámozott találatok következő készletére mutató hivatkozás, ha több találat érhető el; másként nem jelenik meg. | Nem |
IngestionDocumentRequestModel
Egy videodokumentum-betöltési kérelmet jelöl a JSON-dokumentumban.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
mód | húr | Lekéri vagy beállítja a dokumentum betöltési módját. Enumerálás: "add" , "update" "remove" |
Igen |
documentId | húr | Lekéri vagy beállítja a dokumentumazonosítót. | Nem |
documentUrl | sztring (uri) | Lekéri vagy beállítja a dokumentum URL-címét. Ha van ilyen, a közös hozzáférésű jogosultságkód (SAS) törlődik az URL-címről. | Igen |
metaadatok | object | Lekéri vagy beállítja a dokumentum metaadatait név-érték párok szótáraként. | Nem |
userData | object | Lekéri vagy beállítja a dokumentum felhasználói adatait. | Nem |
IngestionDocumentResponseModel
Betöltési dokumentum válaszobjektumát jelöli a JSON-dokumentumban.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
documentId | húr | Lekéri vagy beállítja a dokumentumazonosítót. | Nem |
documentUrl | sztring (uri) | Lekéri vagy beállítja a dokumentum URL-címét. Ha van ilyen, a közös hozzáférésű jogosultságkód (SAS) törlődik az URL-címről. | Nem |
metaadatok | object | Lekéri vagy beállítja a metaadatok kulcs-érték párjait. | Nem |
error | ErrorResponseDetails | Nem | |
createdDateTime | dateTime | Lekéri vagy beállítja a dokumentum létrehozási dátumát és időpontját. | Nem |
lastModifiedDateTime | dateTime | Lekéri vagy beállítja a dokumentum utolsó módosított dátumát és időpontját. | Nem |
userData | object | Lekéri vagy beállítja a dokumentum felhasználói adatait. | Nem |
IngestionDocumentResponseModelCollectionApiModel
Többoldalas eredményeket tartalmazó tömböt tartalmaz.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
Érték | [ IngestionDocumentResponseModel ] | Az eredmények tömbje. | Igen |
nextLink | húr | A lapszámozott találatok következő készletére mutató hivatkozás, ha több találat érhető el; másként nem jelenik meg. | Nem |
IngestionErrorDetailsApiModel
Az egyes dokumentumok betöltési hibaadatait jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
code | húr | Hibakód. | Nem |
üzenet | húr | Hibaüzenet. | Nem |
innerError | IngestionInnerErrorDetailsApiModel | Nem |
IngestionInnerErrorDetailsApiModel
Az egyes dokumentumok betöltési belső hibaadatait jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
code | húr | Hibakód. | Nem |
üzenet | húr | Hibaüzenet. | Nem |
innerError | IngestionInnerErrorDetailsApiModel | Nem |
IngestionResponseModel
A JSON-dokumentum betöltési válaszmodellje.
Név | Típus | Leírás | Szükséges |
---|---|---|---|
név | húr | Lekéri vagy beállítja a betöltés nevét. | Nem |
állapot | húr | Lekéri vagy beállítja a betöltési állapotot. Szám: "notStarted" , "running" , "completed" , "failed" "partiallySucceeded" |
Nem |
error | ErrorResponseDetails | Nem | |
batchName | húr | A betöltéssel társított köteg neve. | Nem |
createdDateTime | dateTime | Lekéri vagy beállítja a betöltési dátumot és időpontot. | Nem |
lastModifiedDateTime | dateTime | Lekéri vagy beállítja a betöltés utolsó módosított dátumát és időpontját. | Nem |
fileStatusDetails | [ IngestionStatusDetailsApiModel ] | Az egyes dokumentumok betöltési állapotainak listája. | Nem |
IngestionResponseModelCollectionApiModel
Többoldalas eredményeket tartalmazó tömböt tartalmaz.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
Érték | [ IngestionResponseModel ] | Az eredmények tömbje. | Igen |
nextLink | húr | A lapszámozott találatok következő készletére mutató hivatkozás, ha több találat érhető el; másként nem jelenik meg. | Nem |
IngestionStatusDetailsApiModel
Az egyes dokumentumok betöltési állapotának részleteit jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
lastUpdateTime | dateTime | A kötegtömb állapotfrissítési ideje. | Igen |
documentId | húr | A dokumentum azonosítója. | Igen |
documentUrl | sztring (uri) | A dokumentum URL-címe. | Nem |
Sikerült | Logikai | Egy jelző, amely jelzi, hogy a következtetés sikeres volt-e. | Igen |
error | IngestionErrorDetailsApiModel | Nem |
MetadataSchemaFieldModel
A metaadat-séma egy mezőjét jelöli.
Név | Típus | Leírás | Szükséges |
---|---|---|---|
név | húr | Lekéri vagy beállítja a mező nevét. | Igen |
searchable | Logikai | Lekéri vagy beállít egy értéket, amely jelzi, hogy a mező kereshető-e. | Igen |
filterable | Logikai | Lekéri vagy beállít egy értéket, amely jelzi, hogy a mező szűrhető-e. | Igen |
típus | húr | Lekéri vagy beállítja a mező típusát. Lehet sztring vagy datetime. Enumerálás: "string" , "datetime" |
Igen |
MetadataSchemaModel
A dokumentum metaadat-sémáját jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
language | húr | Lekéri vagy beállítja a metaadat-séma nyelvét. Az alapértelmezett érték az "en". | Nem |
Mezők | [ MetadataSchemaFieldModel ] | Lekéri vagy beállítja a metaadat-séma mezőlistáját. | Igen |
SearchFiltersModel
A keresési lekérdezésre alkalmazandó szűrőket jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
stringFilters | [ StringFilterModel ] | Lekéri vagy beállítja a keresési lekérdezésre alkalmazandó sztringszűrőket. | Nem |
datetimeFilters | [ DatetimeFilterModel ] | Lekéri vagy beállítja a keresési lekérdezésre alkalmazandó dátum/idő szűrőket. | Nem |
featureFilters | [ sztring ] | Lekéri vagy beállítja a keresési lekérdezésre alkalmazandó funkciószűrőket. | Nem |
SearchQueryTextRequestModel
Szöveges keresés keresési lekérdezési kérési modelljét jelöli.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
queryText | húr | Lekéri vagy beállítja a lekérdezés szövegét. | Igen |
szűrők | SearchFiltersModel | Nem | |
moderálás | Logikai | Logikai értéket kap vagy állít be, amely jelzi, hogy a moderálás engedélyezve vagy letiltva van-e. | Nem |
top | egész szám | Lekéri vagy beállítja a lekérendő eredmények számát. | Igen |
Kihagyás | egész szám | Lekéri vagy beállítja a kihagyandó eredmények számát. | Igen |
additionalIndexNames | [ sztring ] | Lekéri vagy beállítja a keresési lekérdezésben szereplő további indexneveket. | Nem |
deduplik | Logikai | A hasonló videókeretek eltávolítása. | Igen |
dedupMaxDocumentCount | egész szám | A dokumentumok maximális száma a deduplikálás után. | Igen |
disableMetadataSearch | Logikai | Logikai értéket kap vagy állít be, amely jelzi, hogy a metaadatok le vannak-e tiltva a keresésben. | Igen |
SearchResultDocumentModel
Keresési lekérdezési választ jelöl.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
documentId | húr | Lekéri vagy beállítja a dokumentum azonosítóját. | Nem |
documentKind | húr | Lekéri vagy beállítja a dokumentum fajtáját, amely lehet "videó". | Nem |
start | húr | Lekéri vagy beállítja a dokumentum kezdő időpontját. Ez a tulajdonság csak videodokumentumokra vonatkozik. | Nem |
vége | húr | Lekéri vagy beállítja a dokumentum befejezési idejét. Ez a tulajdonság csak videodokumentumokra vonatkozik. | Nem |
legjobb | húr | Lekéri vagy beállítja a dokumentum időbélyegét a legmagasabb relevanciájú pontszámmal. Ez a tulajdonság csak videodokumentumokra vonatkozik. | Nem |
fontosság | double | Lekéri vagy beállítja a dokumentum relevanciapontszámát. | Igen |
továbbiMetadata | object | Lekéri vagy beállítja a kereséshez kapcsolódó további metaadatokat. | Nem |
SearchResultDocumentModelCollectionApiModel
Többoldalas eredményeket tartalmazó tömböt tartalmaz.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
Érték | [ SearchResultDocumentModel ] | Az eredmények tömbje. | Igen |
nextLink | húr | A lapszámozott találatok következő készletére mutató hivatkozás, ha több találat érhető el; másként nem jelenik meg. | Nem |
StringFilterModel
Egy keresési lekérdezésre alkalmazni kívánt sztringszűrőt jelöl.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
fieldName | húr | Lekéri vagy beállítja a szűrni kívánt mező nevét. | Igen |
értékrend | [ sztring ] | Lekéri vagy beállítja a szűrni kívánt értékeket. | Igen |
UpdateIngestionIndexRequestModel
A JSON-dokumentum frissítésbetöltési indexének kérelemmodellje.
Név | Típus | Leírás | Kötelező |
---|---|---|---|
metadataSchema | MetadataSchemaModel | Nem | |
userData | object | Lekéri vagy beállítja a dokumentum felhasználói adatait. | Nem |
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: