Dokumentacja interfejsu API pobierania wideo

Uwierzytelnianie

Dołącz następujące nagłówki podczas wykonywania wywołania do dowolnego interfejsu API w tym dokumencie.

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

CreateIndex

URL

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

opis

Ta metoda tworzy indeks, który następnie może służyć do pozyskiwania dokumentów. Przed rozpoczęciem pozyskiwania należy utworzyć indeks.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu do utworzenia.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string
treść	treść	Treść żądania zawierająca metadane, których można użyć do wyszukiwania.	Tak	CreateIngestionIndexRequestModel

Odpowiedzi

Kod	Description	Type
201	Utwórz	GetIngestionIndexResponseModel

GetIndex

URL

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

opis

Pobiera indeks o określonej nazwie.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu do pobrania.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string

Odpowiedzi

Kod	Description	Type
200	Sukces	GetIngestionIndexResponseModel
domyślna	Błąd	ErrorResponse

UpdateIndex

URL

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

opis

Aktualizuje indeks o określonej nazwie.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu, który ma zostać zaktualizowany.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string
treść	treść	Treść żądania zawierająca aktualizacje, które mają zostać zastosowane do indeksu.	Tak	UpdateIngestionIndexRequestModel

Odpowiedzi

Kod	Description	Type
200	Sukces	GetIngestionIndexResponseModel
domyślna	Błąd	ErrorResponse

DeleteIndex

URL

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

opis

Usuwa indeks i wszystkie skojarzone z nim dokumenty pozyskiwania.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu, który ma zostać usunięty.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string

Odpowiedzi

Kod	opis
204	Brak zawartości

Indeksy list

URL

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

opis

Pobiera listę wszystkich indeksów we wszystkich pozyskiwaniach.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
$skip	zapytanie	Liczba zestawów danych do pominięcia.	Nie.	integer
$top	zapytanie	Liczba zestawów danych, które mają być zwracane po pomijaniu.	Nie.	integer
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string

Odpowiedzi

Kod	Description	Type
200	Sukces	GetIngestionIndexResponseModelCollectionApiModel
domyślna	Błąd	ErrorResponse

CreateIngestion

URL

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

opis

Żądanie pozyskiwania może mieć ładunek wideo. Może mieć jeden z trzech trybów (dodawanie, aktualizowanie lub usuwanie). Tryb dodawania spowoduje utworzenie pozyskiwania i przetworzenie wideo. Tryb aktualizacji zaktualizuje tylko metadane. Aby ponownie przetworzyć film wideo, należy usunąć i ponownie utworzyć pozyskiwanie.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu, do którego ma zostać utworzone pozyskiwanie.	Tak	string
ingestionName	path	Nazwa pozyskiwania do utworzenia.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string
treść	treść	Treść żądania zawierająca żądanie pozyskiwania do utworzenia.	Tak	CreateIngestionRequestModel

Odpowiedzi

Kod	Description	Type
202	Zaakceptowano	IngestionResponseModel

GetIngestion

URL

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

opis

Pobiera stan pozyskiwania dla określonego indeksu i nazwy pozyskiwania.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu, dla którego ma być sprawdzany stan pozyskiwania.	Tak	string
ingestionName	path	Nazwa pozyskiwania do pobrania.	Tak	string
detailLevel	zapytanie	Poziom wskazujący poziom szczegółowości na stan pozyskiwania dokumentu.	Nie.	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string

Odpowiedzi

Kod	Description	Type
200	Sukces	IngestionResponseModel
domyślna	Błąd	ErrorResponse

Pozyskiwanie listIngestions

URL

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

opis

Pobiera wszystkie pozyskiwanie dla określonego indeksu.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu, dla którego mają być pobierane pozyskiwanie.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string

Odpowiedzi

Kod	Description	Type
200	Sukces	IngestionResponseModelCollectionApiModel
domyślna	Błąd	ErrorResponse

ListDocuments

URL

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

opis

Pobiera wszystkie dokumenty dla określonego indeksu.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu, dla którego mają być pobierane dokumenty.	Tak	string
$skip	zapytanie	Liczba zestawów danych do pominięcia.	Nie.	integer
$top	zapytanie	Liczba zestawów danych, które mają być zwracane po pomijaniu.	Nie.	integer
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string

Odpowiedzi

Kod	Description	Type
200	Sukces	IngestionDocumentResponseModelCollectionApiModel
domyślna	Błąd	ErrorResponse

SearchByText

URL

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

opis

Wykonuje wyszukiwanie oparte na tekście na określonym indeksie.

Parametry

Nazwisko	Znajduje się w	opis	Wymagania	Typ
indexName	path	Nazwa indeksu do wyszukania.	Tak	string
api-version	zapytanie	Żądana wersja interfejsu API.	Tak	string
treść	treść	Treść żądania zawierająca zapytanie i inne parametry.	Tak	SearchQueryTextRequestModel

Odpowiedzi

Kod	Description	Type
200	Sukces	SearchResultDocumentModelCollectionApiModel
domyślna	Błąd	ErrorResponse

Modele

CreateIngestionIndexRequestModel

Reprezentuje model żądania tworzenia indeksu pozyskiwania dla dokumentu JSON.

Nazwisko	Pisz	Opis	Wymagania
metadataSchema	MetadataSchemaModel		Nie.
features	[ FeatureModel ]	Pobiera lub ustawia listę funkcji dokumentu. Wartość domyślna to "vision".	Nie.
userData	obiekt	Pobiera lub ustawia dane użytkownika dla dokumentu.	Nie.

CreateIngestionRequestModel

Reprezentuje model żądania tworzenia pozyskiwania dla dokumentu JSON.

Nazwisko	Pisz	Opis	Wymagania
Filmy	[ IngestionDocumentRequestModel ]	Pobiera lub ustawia listę żądań pozyskiwania dokumentów wideo w dokumencie JSON.	Nie.
moderacja	boolean	Pobiera lub ustawia flagę moderowania wskazującą, czy zawartość powinna być moderowana.	Nie.
generateInsightIntervals	boolean	Pobiera lub ustawia flagę generowania interwału, wskazując, czy powinny być generowane interwały szczegółowych informacji.	Nie.
documentAuthenticationKind	string	Pobiera lub ustawia rodzaj uwierzytelniania, który ma być używany do pobierania dokumentów. Wyliczenie: "none", "managedIdentity"	Nie.
filterDefectedFrames	boolean	Flaga filtru ramki wskazująca, że ramki zostaną ocenione, a wszystkie ramki zostaną odfiltrowane (np. rozmyte, słabe światło, prześwietlanie).	Nie.
includeSpeechTranscript	boolean	Pobiera lub ustawia flagę generowania transkrypcji wskazującą, czy należy wygenerować transkrypcję.	Nie.

DatetimeFilterModel

Reprezentuje filtr daty/godziny, który ma być stosowany w zapytaniu wyszukiwania.

Nazwisko	Pisz	Opis	Wymagania
nazwa_pola	string	Pobiera lub ustawia nazwę pola do filtrowania.	Tak
startTime	string	Pobiera lub ustawia godzinę rozpoczęcia zakresu do filtrowania.	Nie.
endTime	string	Pobiera lub ustawia czas zakończenia zakresu do filtrowania.	Nie.

ErrorResponse

Odpowiedź zwrócona po wystąpieniu błędu.

Nazwisko	Pisz	Opis	Wymagania
error	ErrorResponseDetails		Tak

ErrorResponseDetails

Informacje o błędzie.

Nazwisko	Pisz	Opis	Wymagania
code	string	Kod błędu.	Tak
wiadomość	string	Komunikat o błędzie.	Tak
target	string	Element docelowy błędu.	Nie.
szczegóły	[ ErrorResponseDetails ]	Lista szczegółowych błędów.	Nie.
innererror	ErrorResponseInnerError		Nie.

ErrorResponseInnerError

Szczegółowy błąd.

Nazwisko	Pisz	Opis	Wymagania
code	string	Kod błędu.	Tak
wiadomość	string	Komunikat o błędzie.	Tak
innererror	ErrorResponseInnerError		Nie.

FeatureModel

Reprezentuje funkcję w indeksie.

Nazwisko	Pisz	Opis	Wymagania
nazwa	string	Pobiera lub ustawia nazwę funkcji. Wyliczenie: "vision", "speech"	Tak
modelVersion	string	Pobiera lub ustawia wersję modelu funkcji.	Nie.
domena	string	Pobiera lub ustawia domenę modelu funkcji. Wyliczenie: "generic", "surveillance"	Nie.

GetIngestionIndexResponseModel

Reprezentuje model odpowiedzi get ingestion index dla dokumentu JSON.

Nazwisko	Pisz	Opis	Wymagania
nazwa	string	Pobiera lub ustawia właściwość nazwa indeksu.	Nie.
metadataSchema	MetadataSchemaModel		Nie.
userData	obiekt	Pobiera lub ustawia dane użytkownika dla dokumentu.	Nie.
features	[ FeatureModel ]	Pobiera lub ustawia listę funkcji w indeksie.	Nie.
eTag	string	Pobiera lub ustawia element etag.	Tak
createdDateTime	Data i godzina	Pobiera lub ustawia utworzoną właściwość daty i godziny.	Tak
lastModifiedDateTime	Data i godzina	Pobiera lub ustawia właściwość daty i godziny ostatniej modyfikacji.	Tak

GetIngestionIndexResponseModelCollectionApiModel

Zawiera tablicę wyników, które mogą być podzielone na strony.

Nazwisko	Pisz	Opis	Wymagania
wartość	[ GetIngestionIndexResponseModel ]	Tablica wyników.	Tak
nextLink	string	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej wyników; nie ma w przeciwnym razie.	Nie.

IngestionDocumentRequestModel

Reprezentuje żądanie pozyskiwania dokumentu wideo w dokumencie JSON.

Nazwisko	Pisz	Opis	Wymagania
tryb	string	Pobiera lub ustawia tryb pozyskiwania dokumentu. Wyliczenie: "add", , "update""remove"	Tak
documentId	string	Pobiera lub ustawia identyfikator dokumentu.	Nie.
documentUrl	string (identyfikator URI)	Pobiera lub ustawia adres URL dokumentu. Sygnatura dostępu współdzielonego (SAS), jeśli istnieje, zostanie usunięta z adresu URL.	Tak
metadane	obiekt	Pobiera lub ustawia metadane dokumentu jako słownik par name-value.	Nie.
userData	obiekt	Pobiera lub ustawia dane użytkownika dla dokumentu.	Nie.

IngestionDocumentResponseModel

Reprezentuje obiekt odpowiedzi dokumentu pozyskiwania w dokumencie JSON.

Nazwisko	Pisz	Opis	Wymagania
documentId	string	Pobiera lub ustawia identyfikator dokumentu.	Nie.
documentUrl	string (identyfikator URI)	Pobiera lub ustawia adres URL dokumentu. Sygnatura dostępu współdzielonego (SAS), jeśli istnieje, zostanie usunięta z adresu URL.	Nie.
metadane	obiekt	Pobiera lub ustawia pary klucz-wartość metadanych.	Nie.
error	ErrorResponseDetails		Nie.
createdDateTime	Data i godzina	Pobiera lub ustawia utworzoną datę i godzinę dokumentu.	Nie.
lastModifiedDateTime	Data i godzina	Pobiera lub ustawia ostatnią zmodyfikowaną datę i godzinę dokumentu.	Nie.
userData	obiekt	Pobiera lub ustawia dane użytkownika dla dokumentu.	Nie.

IngestionDocumentResponseModelCollectionApiModel

Zawiera tablicę wyników, które mogą być podzielone na strony.

Nazwisko	Pisz	Opis	Wymagania
wartość	[ IngestionDocumentResponseModel ]	Tablica wyników.	Tak
nextLink	string	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej wyników; nie ma w przeciwnym razie.	Nie.

IngestionErrorDetailsApiModel

Reprezentuje informacje o błędzie pozyskiwania dla każdego dokumentu.

Nazwisko	Pisz	Opis	Wymagania
code	string	Kod błędu.	Nie.
wiadomość	string	Komunikat o błędzie.	Nie.
innerError	IngestionInnerErrorDetailsApiModel		Nie.

IngestionInnerErrorDetailsApiModel

Reprezentuje informacje o błędzie wewnętrznym pozyskiwania dla każdego dokumentu.

Nazwisko	Pisz	Opis	Wymagania
code	string	Kod błędu.	Nie.
wiadomość	string	Komunikat o błędzie.	Nie.
innerError	IngestionInnerErrorDetailsApiModel		Nie.

IngestionResponseModel

Reprezentuje model odpowiedzi pozyskiwania dla dokumentu JSON.

Nazwisko	Pisz	Opis	Wymagania
nazwa	string	Pobiera lub ustawia nazwę pozyskiwania.	Nie.
stan	string	Pobiera lub ustawia stan pozyskiwania. Wyliczenie: "notStarted", , "running""completed", , "failed""partiallySucceeded"	Nie.
error	ErrorResponseDetails		Nie.
batchName	string	Nazwa partii skojarzonej z tym pozyskiwaniem.	Nie.
createdDateTime	Data i godzina	Pobiera lub ustawia utworzoną datę i godzinę pozyskiwania.	Nie.
lastModifiedDateTime	Data i godzina	Pobiera lub ustawia ostatnią zmodyfikowaną datę i godzinę pozyskiwania.	Nie.
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	Lista stanów pozyskiwania dla każdego dokumentu.	Nie.

IngestionResponseModelCollectionApiModel

Zawiera tablicę wyników, które mogą być podzielone na strony.

Nazwisko	Pisz	Opis	Wymagania
wartość	[ IngestionResponseModel ]	Tablica wyników.	Tak
nextLink	string	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej wyników; nie ma w przeciwnym razie.	Nie.

IngestionStatusDetailsApiModel

Reprezentuje szczegóły stanu pozyskiwania dla każdego dokumentu.

Nazwisko	Pisz	Opis	Wymagania
lastUpdateTime	Data i godzina	Czas aktualizacji stanu fragmentu wsadowego.	Tak
documentId	string	Identyfikator dokumentu.	Tak
documentUrl	string (identyfikator URI)	Adres URL dokumentu.	Nie.
Zakończyła się pomyślnie	boolean	Flaga wskazująca, czy wnioskowanie zakończyło się pomyślnie.	Tak
error	IngestionErrorDetailsApiModel		Nie.

MetadataSchemaFieldModel

Reprezentuje pole w schemacie metadanych.

Nazwisko	Pisz	Opis	Wymagania
nazwa	string	Pobiera lub ustawia nazwę pola.	Tak
Wyszukiwanie	boolean	Pobiera lub ustawia wartość wskazującą, czy pole można przeszukiwać.	Tak
Filtrowanie	boolean	Pobiera lub ustawia wartość wskazującą, czy pole jest filtrowalne.	Tak
type	string	Pobiera lub ustawia typ pola. Może to być ciąg lub data/godzina. Wyliczenie: "string", "datetime"	Tak

MetadataSchemaModel

Reprezentuje schemat metadanych dla dokumentu.

Nazwisko	Pisz	Opis	Wymagania
język	string	Pobiera lub ustawia język schematu metadanych. Wartość domyślna to "en".	Nie.
pola	[ MetadataSchemaFieldModel ]	Pobiera lub ustawia listę pól w schemacie metadanych.	Tak

SearchFiltersModel

Reprezentuje filtry, które mają być stosowane w zapytaniu wyszukiwania.

Nazwisko	Pisz	Opis	Wymagania
stringFilters	[ StringFilterModel ]	Pobiera lub ustawia filtry ciągów, które mają być stosowane w zapytaniu wyszukiwania.	Nie.
datetimeFilters	[ DatetimeFilterModel ]	Pobiera lub ustawia filtry daty/godziny, które mają być stosowane w zapytaniu wyszukiwania.	Nie.
featureFilters	[ ciąg ]	Pobiera lub ustawia filtry funkcji, które mają być stosowane w zapytaniu wyszukiwania.	Nie.

SearchQueryTextRequestModel

Reprezentuje model żądania zapytania wyszukiwania dla wyszukiwania opartego na tekście.

Nazwisko	Pisz	Opis	Wymagania
queryText	string	Pobiera lub ustawia tekst zapytania.	Tak
filtry	SearchFiltersModel		Nie.
moderacja	boolean	Pobiera lub ustawia wartość logiczną wskazującą, czy moderowanie jest włączone, czy wyłączone.	Nie.
najpopularniejsze	integer	Pobiera lub ustawia liczbę wyników do pobrania.	Tak
skip	integer	Pobiera lub ustawia liczbę wyników do pominięcia.	Tak
additionalIndexNames	[ ciąg ]	Pobiera lub ustawia dodatkowe nazwy indeksów do uwzględnienia w zapytaniu wyszukiwania.	Nie.
deduplikacja	boolean	Czy usunąć podobne ramki wideo.	Tak
dedupMaxDocumentCount	integer	Maksymalna liczba dokumentów po deduplikacji.	Tak
disableMetadataSearch	boolean	Pobiera lub ustawia wartość logiczną wskazującą, czy metadane są wyłączone w wyszukiwaniu, czy nie.	Tak

SearchResultDocumentModel

Reprezentuje odpowiedź zapytania wyszukiwania.

Nazwisko	Pisz	Opis	Wymagania
documentId	string	Pobiera lub ustawia identyfikator dokumentu.	Nie.
documentKind	string	Pobiera lub ustawia rodzaj dokumentu, który może być "wideo".	Nie.
start	string	Pobiera lub ustawia godzinę rozpoczęcia dokumentu. Ta właściwość ma zastosowanie tylko w przypadku dokumentów wideo.	Nie.
end	string	Pobiera lub ustawia godzinę zakończenia dokumentu. Ta właściwość ma zastosowanie tylko w przypadku dokumentów wideo.	Nie.
najlepszy	string	Pobiera lub ustawia znacznik czasu dokumentu z najwyższym wynikiem istotności. Ta właściwość ma zastosowanie tylko w przypadku dokumentów wideo.	Nie.
Mający znaczenie dla	double	Pobiera lub ustawia ocenę istotności dokumentu.	Tak
additionalMetadata	obiekt	Pobiera lub ustawia dodatkowe metadane związane z wyszukiwaniem.	Nie.

SearchResultDocumentModelCollectionApiModel

Zawiera tablicę wyników, które mogą być podzielone na strony.

Nazwisko	Pisz	Opis	Wymagania
wartość	[ SearchResultDocumentModel ]	Tablica wyników.	Tak
nextLink	string	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej wyników; nie ma w przeciwnym razie.	Nie.

StringFilterModel

Reprezentuje filtr ciągu, który ma być stosowany w zapytaniu wyszukiwania.

Nazwisko	Pisz	Opis	Wymagania
nazwa_pola	string	Pobiera lub ustawia nazwę pola do filtrowania.	Tak
wartości	[ ciąg ]	Pobiera lub ustawia wartości do filtrowania.	Tak

UpdateIngestionIndexRequestModel

Reprezentuje model żądania indeksu pozyskiwania aktualizacji dla dokumentu JSON.

Nazwisko	Pisz	Opis	Wymagania
metadataSchema	MetadataSchemaModel		Nie.
userData	obiekt	Pobiera lub ustawia dane użytkownika dla dokumentu.	Nie.