Video Alma API'si başvurusu

Kimlik Doğrulaması

Bu belgedeki herhangi bir API'ye çağrı yaparken aşağıdaki üst bilgileri ekleyin.

Ocp-Apim-Subscription-Key: YOUR_COMPUTER_VISION_KEY Sürüm: 2023-05-01-preview

CreateIndex

URL

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

Açıklama

Bu yöntem, daha sonra belgeleri almak için kullanılabilecek bir dizin oluşturur. Alma işleminin gerçekleştirilebilmesi için önce bir dizin oluşturulması gerekir.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Oluşturulacak dizinin adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize
gövde	gövde	Arama için kullanılabilecek meta verileri içeren istek gövdesi.	Yes	CreateIngestionIndexRequestModel

Yanıtlar

Kod	Description	Tür
201	Oluşturuldu	GetIngestionIndexResponseModel

GetIndex

URL

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

Açıklama

Belirtilen ada sahip dizini alır.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Alınacak dizinin adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize

Yanıtlar

Kod	Description	Tür
200	Başarılı	GetIngestionIndexResponseModel
varsayılan	Hata	ErrorResponse

UpdateIndex

URL

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

Açıklama

Bir dizini belirtilen adla güncelleştirir.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Güncelleştirilecek dizinin adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize
gövde	gövde	Dizine uygulanacak güncelleştirmeleri içeren istek gövdesi.	Yes	UpdateIngestionIndexRequestModel

Yanıtlar

Kod	Description	Tür
200	Başarılı	GetIngestionIndexResponseModel
varsayılan	Hata	ErrorResponse

DeleteIndex

URL

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

Açıklama

Bir dizini ve ilişkili tüm alım belgelerini siler.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Silinecek dizinin adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize

Yanıtlar

Kod	Description
204	İçerik Yok

ListIndexes

URL

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

Açıklama

Tüm alımlar genelindeki tüm dizinlerin listesini alır.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
$skip	query	Atlanacak veri kümesi sayısı.	Hayır	integer
$top	query	Atladıktan sonra döndürülecek veri kümesi sayısı.	Hayır	integer
api-sürümü	query	İstenen API sürümü.	Yes	Dize

Yanıtlar

Kod	Description	Tür
200	Başarılı	GetIngestionIndexResponseModelCollectionApiModel
varsayılan	Hata	ErrorResponse

Oluşturma

URL

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

Açıklama

Alma isteğinin video yükü olabilir. Üç moddan birine sahip olabilir (ekleme, güncelleştirme veya kaldırma). Ekleme modu bir alım oluşturur ve videoyu işler. Güncelleştirme modu yalnızca meta verileri güncelleştirir. Videoyu yeniden işlemek için alımın silinmesi ve yeniden oluşturulması gerekir.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Alımın oluşturulacağı dizinin adı.	Yes	Dize
ingestionName	yol	Oluşturulacak alımın adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize
gövde	gövde	Oluşturulacak alma isteğini içeren istek gövdesi.	Yes	CreateIngestionRequestModel

Yanıtlar

Kod	Description	Tür
202	Kabul edildi	IngestionResponseModel

GetIngestion

URL

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

Açıklama

Belirtilen dizin ve alma adı için alma durumunu alır.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Alım durumunun denetlendiği dizinin adı.	Yes	Dize
ingestionName	yol	Alınacak alımın adı.	Yes	Dize
detailLevel	query	Belge alma durumu başına ayrıntı düzeyini gösteren düzey.	Hayır	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize

Yanıtlar

Kod	Description	Tür
200	Başarılı	IngestionResponseModel
varsayılan	Hata	ErrorResponse

ListIngestions

URL

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

Açıklama

Belirli bir dizin için tüm alımları alır.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Alımların alındığı dizinin adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize

Yanıtlar

Kod	Description	Tür
200	Başarılı	IngestionResponseModelCollectionApiModel
varsayılan	Hata	ErrorResponse

ListDocuments

URL

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

Açıklama

Belirli bir dizin için tüm belgeleri alır.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Belgelerin alındığı dizinin adı.	Yes	Dize
$skip	query	Atlanacak veri kümesi sayısı.	Hayır	integer
$top	query	Atladıktan sonra döndürülecek veri kümesi sayısı.	Hayır	integer
api-sürümü	query	İstenen API sürümü.	Yes	Dize

Yanıtlar

Kod	Description	Tür
200	Başarılı	IngestionDocumentResponseModelCollectionApiModel
varsayılan	Hata	ErrorResponse

SearchByText

URL

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

Açıklama

Belirtilen dizinde metin tabanlı bir arama gerçekleştirir.

Parametreler

Veri Akışı Adı	Bulunduğu yer:	Açıklama	Gerekli	Tür
indexName	yol	Aranacak dizinin adı.	Yes	Dize
api-sürümü	query	İstenen API sürümü.	Yes	Dize
gövde	gövde	Sorguyu ve diğer parametreleri içeren istek gövdesi.	Yes	SearchQueryTextRequestModel

Yanıtlar

Kod	Description	Tür
200	Başarılı	SearchResultDocumentModelCollectionApiModel
varsayılan	Hata	ErrorResponse

Modeller

CreateIngestionIndexRequestModel

JSON belgesi için oluşturma alma dizini istek modelini temsil eder.

Adı	Tür	Açıklama	Gerekli
metadataSchema	MetadataSchemaModel		Hayır
features	[ FeatureModel ]	Belgenin özellik listesini alır veya ayarlar. Varsayılan değer "görüntü"dür.	Hayır
userData	nesne	Belge için kullanıcı verilerini alır veya ayarlar.	Hayır

CreateIngestionRequestModel

JSON belgesi için oluşturma alma isteği modelini temsil eder.

Adı	Tür	Açıklama	Gerekli
Video	[ IngestionDocumentRequestModel ]	JSON belgesindeki video belgesi alma isteklerinin listesini alır veya ayarlar.	Hayır
moderasyon	boolean	İçeriğin denetlenmesi gerekip gerekmediğini belirten denetim bayrağını alır veya ayarlar.	Hayır
generateInsightIntervals	boolean	İçgörü aralıklarının oluşturulması gerekip gerekmediğini gösteren aralık oluşturma bayrağını alır veya ayarlar.	Hayır
documentAuthenticationKind	Dize	Belgeleri indirmek için kullanılacak kimlik doğrulama türünü alır veya ayarlar. Sabit listesi: "none", "managedIdentity"	Hayır
filterDefectedFrames	boolean	Çerçevelerin değerlendirileceğini gösteren çerçeve filtre bayrağı değerlendirilir ve tüm kusurlu çerçeveler (bulanık, düşük ışık, aşırı maruz kalır) çerçeveler filtrelenir.	Hayır
includeSpeechTranscript	boolean	Transkript oluşturma bayrağını alır veya ayarlar ve transkript oluşturulıp oluşturulmaması gerektiğini belirtir.	Hayır

DatetimeFilterModel

Arama sorgusuna uygulanacak tarih saat filtresini temsil eder.

Adı	Tür	Açıklama	Gerekli
fieldName	Dize	Filtre uygulanacak alanın adını alır veya ayarlar.	Yes
startTime	Dize	Filtre uygulanacak aralığın başlangıç saatini alır veya ayarlar.	Hayır
endTime	Dize	Filtre uygulanacak aralığın bitiş saatini alır veya ayarlar.	Hayır

ErrorResponse

Bir hata oluştuğunda yanıt döndürüldü.

Adı	Tür	Açıklama	Gerekli
hata	ErrorResponseDetails		Yes

ErrorResponseDetails

Hata bilgileri.

Adı	Tür	Açıklama	Gerekli
kod	Dize	Hata kodu.	Yes
ileti	Dize	Hata iletisi.	Yes
hedef	Dize	Hatanın hedefi.	Hayır
ayrıntılar	[ ErrorResponseDetails ]	Ayrıntılı hataların listesi.	Hayır
innererror	ErrorResponseInnerError		Hayır

ErrorResponseInnerError

Ayrıntılı hata.

Adı	Tür	Açıklama	Gerekli
kod	Dize	Hata kodu.	Yes
ileti	Dize	Hata iletisi.	Yes
innererror	ErrorResponseInnerError		Hayır

FeatureModel

Dizindeki bir özelliği temsil eder.

Adı	Tür	Açıklama	Gerekli
Adı	Dize	Özelliğin adını alır veya ayarlar. Sabit listesi: "vision", "speech"	Yes
modelVersion	Dize	Özelliğin model sürümünü alır veya ayarlar.	Hayır
etki alanı	Dize	Özelliğin model etki alanını alır veya ayarlar. Sabit listesi: "generic", "surveillance"	Hayır

GetIngestionIndexResponseModel

JSON belgesi için alma alma dizini yanıt modelini temsil eder.

Adı	Tür	Açıklama	Gerekli
Adı	Dize	Dizin adı özelliğini alır veya ayarlar.	Hayır
metadataSchema	MetadataSchemaModel		Hayır
userData	nesne	Belge için kullanıcı verilerini alır veya ayarlar.	Hayır
features	[ FeatureModel ]	Dizindeki özelliklerin listesini alır veya ayarlar.	Hayır
eTag	Dize	Etag'i alır veya ayarlar.	Yes
createdDateTime	tarih saat	Oluşturulan tarih ve saat özelliğini alır veya ayarlar.	Yes
lastModifiedDateTime	tarih saat	Son değiştirilen tarih ve saat özelliğini alır veya ayarlar.	Yes

GetIngestionIndexResponseModelCollectionApiModel

Sayfalandırılmış olabilecek bir sonuç dizisi içerir.

Adı	Tür	Açıklama	Gerekli
değer	[ GetIngestionIndexResponseModel ]	Sonuç dizisi.	Yes
nextLink	Dize	Daha fazla sonuç varsa sonraki sayfalandırılmış sonuç kümesinin bağlantısı; aksi halde mevcut değildir.	Hayır

IngestionDocumentRequestModel

JSON belgesindeki bir video belgesi alma isteğini temsil eder.

Adı	Tür	Açıklama	Gerekli
mod	Dize	Belge alımı modunu alır veya ayarlar. Sabit listesi: "add", "update", "remove"	Yes
documentId	Dize	Belge kimliğini alır veya ayarlar.	Hayır
documentUrl	dize (uri)	Belge URL'sini alır veya ayarlar. Varsa, paylaşılan erişim imzası (SAS) URL'den kaldırılır.	Yes
meta veriler	nesne	Belgenin meta verilerini ad-değer çiftlerinin sözlüğü olarak alır veya ayarlar.	Hayır
userData	nesne	Belge için kullanıcı verilerini alır veya ayarlar.	Hayır

IngestionDocumentResponseModel

JSON belgesindeki bir alma belgesi yanıt nesnesini temsil eder.

Adı	Tür	Açıklama	Gerekli
documentId	Dize	Belge kimliğini alır veya ayarlar.	Hayır
documentUrl	dize (uri)	Belge URL'sini alır veya ayarlar. Varsa, paylaşılan erişim imzası (SAS) URL'den kaldırılır.	Hayır
meta veriler	nesne	Meta verilerin anahtar-değer çiftlerini alır veya ayarlar.	Hayır
hata	ErrorResponseDetails		Hayır
createdDateTime	tarih saat	Belgenin oluşturulan tarih ve saatini alır veya ayarlar.	Hayır
lastModifiedDateTime	tarih saat	Belgenin son değiştirme tarihini ve saatini alır veya ayarlar.	Hayır
userData	nesne	Belge için kullanıcı verilerini alır veya ayarlar.	Hayır

IngestionDocumentResponseModelCollectionApiModel

Sayfalandırılmış olabilecek bir sonuç dizisi içerir.

Adı	Tür	Açıklama	Gerekli
değer	[ IngestionDocumentResponseModel ]	Sonuç dizisi.	Yes
nextLink	Dize	Daha fazla sonuç varsa sonraki sayfalandırılmış sonuç kümesinin bağlantısı; aksi halde mevcut değildir.	Hayır

IngestionErrorDetailsApiModel

Her belge için alma hatası bilgilerini temsil eder.

Adı	Tür	Açıklama	Gerekli
kod	Dize	Hata kodu.	Hayır
ileti	Dize	Hata iletisi.	Hayır
innerError	IngestionInnerErrorDetailsApiModel		Hayır

IngestionInnerErrorDetailsApiModel

Her belge için alım iç hata bilgilerini temsil eder.

Adı	Tür	Açıklama	Gerekli
kod	Dize	Hata kodu.	Hayır
ileti	Dize	Hata iletisi.	Hayır
innerError	IngestionInnerErrorDetailsApiModel		Hayır

IngestionResponseModel

JSON belgesi için alım yanıt modelini temsil eder.

Adı	Tür	Açıklama	Gerekli
Adı	Dize	Alımın adını alır veya ayarlar.	Hayır
semt	Dize	Alımın durumunu alır veya ayarlar. Sabit Listesi: "notStarted", "running", "completed", "failed", "partiallySucceeded"	Hayır
hata	ErrorResponseDetails		Hayır
batchName	Dize	Bu alma işlemiyle ilişkili toplu iş adı.	Hayır
createdDateTime	tarih saat	Alımın oluşturulan tarih ve saatini alır veya ayarlar.	Hayır
lastModifiedDateTime	tarih saat	Alımın son değiştirme tarihini ve saatini alır veya ayarlar.	Hayır
fileStatusDetails	[ IngestionStatusDetailsApiModel ]	Her belge için alım durumlarının listesi.	Hayır

IngestionResponseModelCollectionApiModel

Sayfalandırılmış olabilecek bir sonuç dizisi içerir.

Adı	Tür	Açıklama	Gerekli
değer	[ IngestionResponseModel ]	Sonuç dizisi.	Yes
nextLink	Dize	Daha fazla sonuç varsa sonraki sayfalandırılmış sonuç kümesinin bağlantısı; aksi halde mevcut değildir.	Hayır

IngestionStatusDetailsApiModel

Her belge için alım durumu ayrıntılarını temsil eder.

Adı	Tür	Açıklama	Gerekli
lastUpdateTime	tarih saat	Toplu iş öbeklerinin durum güncelleştirme zamanı.	Yes
documentId	Dize	Belge kimliği.	Yes
documentUrl	dize (uri)	Belgenin URL'si.	Hayır
Başarılı	boolean	Çıkarım işleminin başarılı olup olmadığını belirten bir bayrak.	Yes
hata	IngestionErrorDetailsApiModel		Hayır

MetadataSchemaFieldModel

Meta veri şemasındaki bir alanı temsil eder.

Adı	Tür	Açıklama	Gerekli
Adı	Dize	Alanın adını alır veya ayarlar.	Yes
aranabilir	boolean	Alanın aranabilir olup olmadığını belirten bir değer alır veya ayarlar.	Yes
filtrelenebilir	boolean	Alanın filtrelenebilir olup olmadığını belirten bir değer alır veya ayarlar.	Yes
Tür	Dize	Alanın türünü alır veya ayarlar. Dize veya tarih saat olabilir. Sabit listesi: "string", "datetime"	Yes

MetadataSchemaModel

Belgenin meta veri şemasını temsil eder.

Adı	Tür	Açıklama	Gerekli
dil	Dize	Meta veri şemasının dilini alır veya ayarlar. Varsayılan değer "en"dir.	Hayır
Alanları	[ MetadataSchemaFieldModel ]	Meta veri şemasındaki alanların listesini alır veya ayarlar.	Yes

SearchFiltersModel

Arama sorgusuna uygulanacak filtreleri temsil eder.

Adı	Tür	Açıklama	Gerekli
stringFilters	[ StringFilterModel ]	Arama sorgusuna uygulanacak dize filtrelerini alır veya ayarlar.	Hayır
datetimeFilters	[ DatetimeFilterModel ]	Arama sorgusuna uygulanacak tarih saat filtrelerini alır veya ayarlar.	Hayır
featureFilters	[ dize ]	Arama sorgusuna uygulanacak özellik filtrelerini alır veya ayarlar.	Hayır

SearchQueryTextRequestModel

Metin tabanlı arama için bir arama sorgusu istek modelini temsil eder.

Adı	Tür	Açıklama	Gerekli
queryText	Dize	Sorgu metnini alır veya ayarlar.	Yes
filtreler	SearchFiltersModel		Hayır
moderasyon	boolean	Moderasyonun etkinleştirildiğini veya devre dışı bırakıldığını belirten bir boole değeri alır veya ayarlar.	Hayır
üst	integer	Alınacak sonuç sayısını alır veya ayarlar.	Yes
skip	integer	Atacak sonuç sayısını alır veya ayarlar.	Yes
additionalIndexNames	[ dize ]	Arama sorgusuna eklenecek ek dizin adlarını alır veya ayarlar.	Hayır
yinelenenleri kaldırma	boolean	Benzer video karelerinin kaldırılıp kaldırılmayacağı.	Yes
dedupMaxDocumentCount	integer	Yinelenenleri kaldırdıktan sonra belge sayısı üst sınırı.	Yes
disableMetadataSearch	boolean	Meta verilerin aramada devre dışı bırakılıp bırakılmadığını belirten bir boole değeri alır veya ayarlar.	Yes

SearchResultDocumentModel

Arama sorgusu yanıtlarını temsil eder.

Adı	Tür	Açıklama	Gerekli
documentId	Dize	Belgenin kimliğini alır veya ayarlar.	Hayır
documentKind	Dize	"Video" olabilecek belge türünü alır veya ayarlar.	Hayır
start	Dize	Belgenin başlangıç saatini alır veya ayarlar. Bu özellik yalnızca video belgeleri için geçerlidir.	Hayır
end	Dize	Belgenin bitiş saatini alır veya ayarlar. Bu özellik yalnızca video belgeleri için geçerlidir.	Hayır
en iyi	Dize	En yüksek ilgi puanına sahip belgenin zaman damgasını alır veya ayarlar. Bu özellik yalnızca video belgeleri için geçerlidir.	Hayır
ilgililik	çift	Belgenin ilgi puanını alır veya ayarlar.	Yes
additionalMetadata	nesne	Aramayla ilgili ek meta verileri alır veya ayarlar.	Hayır

SearchResultDocumentModelCollectionApiModel

Sayfalandırılmış olabilecek bir sonuç dizisi içerir.

Adı	Tür	Açıklama	Gerekli
değer	[ SearchResultDocumentModel ]	Sonuç dizisi.	Yes
nextLink	Dize	Daha fazla sonuç varsa sonraki sayfalandırılmış sonuç kümesinin bağlantısı; aksi halde mevcut değildir.	Hayır

StringFilterModel

Arama sorgusuna uygulanacak dize filtresini temsil eder.

Adı	Tür	Açıklama	Gerekli
fieldName	Dize	Filtre uygulanacak alanın adını alır veya ayarlar.	Yes
Değer	[ dize ]	Filtre uygulamak için değerleri alır veya ayarlar.	Yes

UpdateIngestionIndexRequestModel

JSON belgesi için güncelleştirme alımı dizin istek modelini temsil eder.

Adı	Tür	Açıklama	Gerekli
metadataSchema	MetadataSchemaModel		Hayır
userData	nesne	Belge için kullanıcı verilerini alır veya ayarlar.	Hayır