Referenční informace k rozhraní API pro načítání videa

Ověřování

Při volání libovolného rozhraní API v tomto dokumentu zahrňte následující hlavičky.

Ocp-Apim-Subscription-Key: Verze: YOUR_COMPUTER_VISION_KEY2023-05-01-preview

CreateIndex

Adresa URL

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

Popis

Tato metoda vytvoří index, který se pak dá použít k ingestování dokumentů. Před provedením příjmu dat je potřeba vytvořit index.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, který se má vytvořit.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string
text	text	Text požadavku obsahující metadata, která se dají použít k vyhledávání.	Ano	CreateIngestionIndexRequestModel

Odpovědi

Kód	Description	Typ
201	Vytvořeno	GetIngestionIndexResponseModel

GetIndex

Adresa URL

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

Popis

Načte index se zadaným názvem.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, který se má načíst.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	GetIngestionIndexResponseModel
default	Chyba	ErrorResponse

UpdateIndex

Adresa URL

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

Popis

Aktualizuje index se zadaným názvem.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, který se má aktualizovat.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string
text	text	Text požadavku obsahující aktualizace, které se mají použít na index.	Ano	UpdateIngestionIndexRequestModel

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	GetIngestionIndexResponseModel
default	Chyba	ErrorResponse

DeleteIndex

Adresa URL

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

Popis

Odstraní index a všechny přidružené dokumenty příjmu dat.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, který se má odstranit.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string

Odpovědi

Kód	Popis
204	Žádný obsah

ListIndexes

Adresa URL

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

Popis

Načte seznam všech indexů napříč všemi příjmy dat.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
$skip	query	Počet datových sad, které se mají přeskočit	No	integer
$top	query	Počet datových sad, které se mají vrátit po přeskočení	No	integer
verze-api	query	Požadovaná verze rozhraní API	Ano	string

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	GetIngestionIndexResponseModelCollectionApiModel
default	Chyba	ErrorResponse

Vytvořeníingestionu

Adresa URL

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

Popis

Žádost o příjem dat může mít datovou část videa. Může mít jeden ze tří režimů (přidání, aktualizace nebo odebrání). Režim přidání vytvoří příjem dat a zpracuje video. Režim aktualizace aktualizuje pouze metadata. Aby bylo možné video znovu zpracovat, je potřeba ingestování odstranit a znovu vytvořit.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, ke kterému se má příjem dat vytvořit.	Ano	string
ingestionName	path	Název příjmu dat, který se má vytvořit.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string
text	text	Text požadavku obsahující požadavek na příjem dat, který se má vytvořit.	Ano	CreateIngestionRequestModel

Odpovědi

Kód	Description	Typ
202	Přijato	IngestionResponseModel

GetIngestion

Adresa URL

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

Popis

Získá stav příjmu dat pro zadaný název indexu a příjmu dat.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, pro který se má kontrolovat stav příjmu dat.	Ano	string
ingestionName	path	Název příjmu dat, který se má načíst.	Ano	string
detailLevel	query	Úroveň označující úroveň podrobností na stav příjmu dokumentů.	No	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	IngestionResponseModel
default	Chyba	ErrorResponse

Výpisy

Adresa URL

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

Popis

Načte všechna příjem dat pro konkrétní index.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, pro který se mají načíst příjem dat.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	IngestionResponseModelCollectionApiModel
default	Chyba	ErrorResponse

ListDocuments

Adresa URL

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

Popis

Načte všechny dokumenty pro konkrétní index.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, pro který chcete načíst dokumenty.	Ano	string
$skip	query	Počet datových sad, které se mají přeskočit	No	integer
$top	query	Počet datových sad, které se mají vrátit po přeskočení	No	integer
verze-api	query	Požadovaná verze rozhraní API	Ano	string

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	IngestionDocumentResponseModelCollectionApiModel
default	Chyba	ErrorResponse

SearchByText

Adresa URL

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

Popis

Provede textové vyhledávání na zadaném indexu.

Parametry

Název	Nachází se v	Popis	Povinní účastníci	Typ
indexName	path	Název indexu, který se má prohledávat.	Ano	string
verze-api	query	Požadovaná verze rozhraní API	Ano	string
text	text	Text požadavku obsahující dotaz a další parametry.	Ano	SearchQueryTextRequestModel

Odpovědi

Kód	Description	Typ
200	Akce proběhla úspěšně	SearchResultDocumentModelCollectionApiModel
default	Chyba	ErrorResponse

Modely

CreateIngestionIndexRequestModel

Představuje model žádosti o vytvoření indexu příjmu dat pro dokument JSON.

Name	Typ	Popis	Povinní účastníci
metadataSchema	MetadataSchemaModel		No
features	[ FeatureModel ]	Získá nebo nastaví seznam funkcí dokumentu. Výchozí hodnota je "vize".	No
userData	objekt	Získá nebo nastaví uživatelská data pro dokument.	No

CreateIngestionRequestModel

Představuje model žádosti o vytvoření příjmu dat pro dokument JSON.

Name	Typ	Popis	Povinní účastníci
videa	[ IngestionDocumentRequestModel ]	Získá nebo nastaví seznam žádostí o příjem videodokumentů v dokumentu JSON.	No
moderování	boolean	Získá nebo nastaví příznak moderování, který označuje, jestli má být obsah moderován.	No
generateInsightIntervals	boolean	Získá nebo nastaví příznak generování intervalu označující, jestli se mají generovat intervaly přehledu.	No
documentAuthenticationKind	string	Získá nebo nastaví typ ověřování, který se má použít ke stažení dokumentů. Výčt: "none", "managedIdentity"	No
filterDefectedFrames	boolean	Příznak filtru rámečku označující snímky se vyhodnotí a vyfiltrují se všechny vadné snímky (např. rozmazané, nízké světlo, přeexpozice).	No
includeSpeechTranscript	boolean	Získá nebo nastaví příznak generování přepisu označující, jestli se má vygenerovat přepis.	No

DatetimeFilterModel

Představuje filtr data a času, který se použije u vyhledávacího dotazu.

Name	Typ	Popis	Povinní účastníci
fieldName	string	Získá nebo nastaví název pole pro filtrování.	Ano
startTime	string	Získá nebo nastaví počáteční čas rozsahu pro filtrování.	No
endTime	string	Získá nebo nastaví koncový čas rozsahu pro filtrování.	No

ErrorResponse

Odpověď se vrátí, když dojde k chybě.

Name	Typ	Popis	Povinní účastníci
chyba	ErrorResponseDetails		Ano

ErrorResponseDetails

Informace o chybě

Name	Typ	Popis	Povinní účastníci
code	string	Kód chyby	Ano
zpráva	string	Chybová zpráva.	Ano
target	string	Cíl chyby.	No
Podrobnosti	[ ErrorResponseDetails ]	Seznam podrobných chyb	No
innererror	ErrorResponseInnerError		No

ErrorResponseInnerError

Podrobná chyba

Name	Typ	Popis	Povinní účastníci
code	string	Kód chyby	Ano
zpráva	string	Chybová zpráva.	Ano
innererror	ErrorResponseInnerError		No

FeatureModel

Představuje funkci v indexu.

Name	Typ	Popis	Povinní účastníci
name	string	Získá nebo nastaví název funkce. Výčt: "vision", "speech"	Ano
modelVersion	string	Získá nebo nastaví verzi modelu funkce.	No
domain	string	Získá nebo nastaví doménu modelu funkce. Výčt: "generic", "surveillance"	No

GetIngestionIndexResponseModel

Představuje model odpovědi indexu příjmu příjmu dat pro dokument JSON.

Name	Typ	Popis	Povinní účastníci
name	string	Získá nebo nastaví vlastnost názvu indexu.	No
metadataSchema	MetadataSchemaModel		No
userData	objekt	Získá nebo nastaví uživatelská data pro dokument.	No
features	[ FeatureModel ]	Získá nebo nastaví seznam funkcí v indexu.	No
eTag	string	Získá nebo nastaví značku etag.	Ano
createdDateTime	data a času.	Získá nebo nastaví vytvořenou vlastnost data a času.	Ano
lastModifiedDateTime	data a času.	Získá nebo nastaví vlastnost data a času poslední změny.	Ano

GetIngestionIndexResponseModelCollectionApiModel

Obsahuje pole výsledků, které mohou být stránkovány.

Name	Typ	Popis	Povinní účastníci
hodnota	[ GetIngestionIndexResponseModel ]	Pole výsledků.	Ano
nextLink	string	Odkaz na další sadu stránkovaných výsledků, pokud jsou k dispozici další výsledky; není k dispozici jinak.	No

IngestionDocumentRequestModel

Představuje žádost o příjem videodokumentu v dokumentu JSON.

Name	Typ	Popis	Povinní účastníci
režim	string	Získá nebo nastaví režim příjmu dat pro dokument. Výčt: "add", , "update""remove"	Ano
documentId	string	Získá nebo nastaví ID dokumentu.	No
documentUrl	string (URI)	Získá nebo nastaví adresu URL dokumentu. Sdílený přístupový podpis (SAS), pokud existuje, se z adresy URL odebere.	Ano
metadata	objekt	Získá nebo nastaví metadata dokumentu jako slovník párů název-hodnota.	No
userData	objekt	Získá nebo nastaví uživatelská data pro dokument.	No

IngestionDocumentResponseModel

Představuje objekt odpovědi dokumentu příjmu dat v dokumentu JSON.

Name	Typ	Popis	Povinní účastníci
documentId	string	Získá nebo nastaví ID dokumentu.	No
documentUrl	string (URI)	Získá nebo nastaví adresu URL dokumentu. Sdílený přístupový podpis (SAS), pokud existuje, se z adresy URL odebere.	No
metadata	objekt	Získá nebo nastaví páry klíč-hodnota metadat.	No
chyba	ErrorResponseDetails		No
createdDateTime	data a času.	Získá nebo nastaví datum a čas vytvoření dokumentu.	No
lastModifiedDateTime	data a času.	Získá nebo nastaví datum a čas poslední změny dokumentu.	No
userData	objekt	Získá nebo nastaví uživatelská data pro dokument.	No

IngestionDocumentResponseModelCollectionApiModel

Obsahuje pole výsledků, které mohou být stránkovány.

Name	Typ	Popis	Povinní účastníci
hodnota	[ IngestionDocumentResponseModel ]	Pole výsledků.	Ano
nextLink	string	Odkaz na další sadu stránkovaných výsledků, pokud jsou k dispozici další výsledky; není k dispozici jinak.	No

IngestionErrorDetailsApiModel

Představuje informace o chybách příjmu dat pro každý dokument.

Name	Typ	Popis	Povinní účastníci
code	string	Kód chyby	No
zpráva	string	Chybová zpráva.	No
innerError	IngestionInnerErrorDetailsApiModel		No

IngestionInnerErrorDetailsApiModel

Představuje informace o vnitřní chybě příjmu dat pro každý dokument.

Name	Typ	Popis	Povinní účastníci
code	string	Kód chyby	No
zpráva	string	Chybová zpráva.	No
innerError	IngestionInnerErrorDetailsApiModel		No

IngestionResponseModel

Představuje model odpovědi na příjem dat pro dokument JSON.

Name	Typ	Popis	Povinní účastníci
name	string	Získá nebo nastaví název příjmu dat.	No
state	string	Získá nebo nastaví stav příjmu dat. Výčt: "notStarted", "running", "completed", , "failed""partiallySucceeded"	No
chyba	ErrorResponseDetails		No
batchName	string	Název dávky přidružené k tomuto příjmu dat.	No
createdDateTime	data a času.	Získá nebo nastaví vytvořené datum a čas příjmu dat.	No
lastModifiedDateTime	data a času.	Získá nebo nastaví datum a čas poslední změny příjmu dat.	No
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	Seznam stavů příjmu dat pro každý dokument	No

IngestionResponseModelCollectionApiModel

Obsahuje pole výsledků, které mohou být stránkovány.

Name	Typ	Popis	Povinní účastníci
hodnota	[ IngestionResponseModel ]	Pole výsledků.	Ano
nextLink	string	Odkaz na další sadu stránkovaných výsledků, pokud jsou k dispozici další výsledky; není k dispozici jinak.	No

IngestionStatusDetailsApiModel

Představuje podrobnosti o stavu příjmu dat pro každý dokument.

Name	Typ	Popis	Povinní účastníci
lastUpdateTime	data a času.	Čas aktualizace stavu dávkového bloku	Ano
documentId	string	ID dokumentu.	Ano
documentUrl	string (URI)	Adresa URL dokumentu.	No
uspěl	boolean	Příznak, který označuje, jestli bylo odvození úspěšné.	Ano
chyba	IngestionErrorDetailsApiModel		No

MetadataSchemaFieldModel

Představuje pole ve schématu metadat.

Name	Typ	Popis	Povinní účastníci
name	string	Získá nebo nastaví název pole.	Ano
searchable	boolean	Získá nebo nastaví hodnotu určující, zda je pole prohledávatelné.	Ano
filterable	boolean	Získá nebo nastaví hodnotu označující, zda je pole filtrovatelné.	Ano
type	string	Získá nebo nastaví typ pole. Může to být řetězec nebo datum a čas. Výčt: "string", "datetime"	Ano

MetadataSchemaModel

Představuje schéma metadat pro dokument.

Name	Typ	Popis	Povinní účastníci
jazyk	string	Získá nebo nastaví jazyk schématu metadat. Výchozí hodnota je en.	No
pole	[ MetadataSchemaFieldModel ]	Získá nebo nastaví seznam polí ve schématu metadat.	Ano

SearchFiltersModel

Představuje filtry, které se mají použít u vyhledávacího dotazu.

Name	Typ	Popis	Povinní účastníci
stringFilters	[ StringFilterModel ]	Získá nebo nastaví filtry řetězců, které se použijí pro vyhledávací dotaz.	No
datetimeFilters	[ DatetimeFilterModel ]	Získá nebo nastaví filtry data a času, které se použijí pro vyhledávací dotaz.	No
featureFilters	[ řetězec ]	Získá nebo nastaví filtry funkcí, které se použijí pro vyhledávací dotaz.	No

SearchQueryTextRequestModel

Představuje model požadavku vyhledávacího dotazu pro textové vyhledávání.

Name	Typ	Popis	Povinní účastníci
queryText	string	Získá nebo nastaví text dotazu.	Ano
Filtry	SearchFiltersModel		No
moderování	boolean	Získá nebo nastaví logickou hodnotu označující, zda je moderování povoleno nebo zakázáno.	No
nejlepší	integer	Získá nebo nastaví počet výsledků, které se mají načíst.	Ano
skip	integer	Získá nebo nastaví počet výsledků, které se mají přeskočit.	Ano
additionalIndexNames	[ řetězec ]	Získá nebo nastaví další názvy indexů, které mají být zahrnuty do vyhledávacího dotazu.	No
odstranění duplicitních dat	boolean	Zda chcete odebrat podobné snímky videa.	Ano
dedupMaxDocumentCount	integer	Maximální počet dokumentů po odstranění.	Ano
disableMetadataSearch	boolean	Získá nebo nastaví logickou hodnotu označující, zda jsou metadata zakázána ve vyhledávání nebo ne.	Ano

SearchResultDocumentModel

Představuje odpověď vyhledávacího dotazu.

Name	Typ	Popis	Povinní účastníci
documentId	string	Získá nebo nastaví ID dokumentu.	No
documentKind	string	Získá nebo nastaví typ dokumentu, který může být "video".	No
start	string	Získá nebo nastaví počáteční čas dokumentu. Tato vlastnost se vztahuje pouze na video dokumenty.	No
end	string	Získá nebo nastaví koncový čas dokumentu. Tato vlastnost se vztahuje pouze na video dokumenty.	No
nejlepší	string	Získá nebo nastaví časové razítko dokumentu s nejvyšším skóre relevance. Tato vlastnost se vztahuje pouze na video dokumenty.	No
význam	double	Získá nebo nastaví skóre relevance dokumentu.	Ano
additionalMetadata	objekt	Získá nebo nastaví další metadata související s vyhledáváním.	No

SearchResultDocumentModelCollectionApiModel

Obsahuje pole výsledků, které mohou být stránkovány.

Name	Typ	Popis	Povinní účastníci
hodnota	[ SearchResultDocumentModel ]	Pole výsledků.	Ano
nextLink	string	Odkaz na další sadu stránkovaných výsledků, pokud jsou k dispozici další výsledky; není k dispozici jinak.	No

StringFilterModel

Představuje filtr řetězců, který se má použít u vyhledávacího dotazu.

Name	Typ	Popis	Povinní účastníci
fieldName	string	Získá nebo nastaví název pole pro filtrování.	Ano
hodnoty	[ řetězec ]	Získá nebo nastaví hodnoty pro filtrování.	Ano

UpdateIngestionIndexRequestModel

Představuje model žádosti o index příjmu aktualizací pro dokument JSON.

Name	Typ	Popis	Povinní účastníci
metadataSchema	MetadataSchemaModel		No
userData	objekt	Získá nebo nastaví uživatelská data pro dokument.	Ne