Bagikan melalui

Referensi API Pengambilan Video

  • Artikel

Autentikasi

Sertakan header berikut saat melakukan panggilan ke API apa pun dalam dokumen ini.

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

CreateIndex

URL

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

Deskripsi

Metode ini membuat indeks, yang kemudian dapat digunakan untuk menyerap dokumen. Indeks perlu dibuat sebelum penyerapan dapat dilakukan.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks yang akan dibuat. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string
body body Isi permintaan yang berisi metadata yang dapat digunakan untuk pencarian. Ya CreateIngestionIndexRequestModel

Respons

Kode Deskripsi Jenis
201 Dibuat GetIngestionIndexResponseModel

GetIndex

URL

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

Deskripsi

Mengambil indeks dengan nama yang ditentukan.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks yang akan diambil. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string

Respons

Kode Deskripsi Jenis
200 Berhasil GetIngestionIndexResponseModel
Default Kesalahan ErrorResponse

UpdateIndex

URL

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

Deskripsi

Memperbarui indeks dengan nama yang ditentukan.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks yang akan diperbarui. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string
body body Isi permintaan yang berisi pembaruan yang akan diterapkan ke indeks. Ya UpdateIngestionIndexRequestModel

Respons

Kode Deskripsi Jenis
200 Berhasil GetIngestionIndexResponseModel
Default Kesalahan ErrorResponse

DeleteIndex

URL

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

Deskripsi

Menghapus indeks dan semua dokumen penyerapan terkait.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks yang akan dihapus. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string

Respons

Kode Deskripsi
204 Tidak ada Konten

ListIndexes

URL

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

Deskripsi

Mengambil daftar semua indeks di semua penyerapan.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
$skip pertanyaan Jumlah himpunan data yang akan dilewati. No Integer
$top pertanyaan Jumlah himpunan data yang akan dikembalikan setelah dilewati. No Integer
versi-api pertanyaan Versi API yang diminta. Ya string

Respons

Kode Deskripsi Jenis
200 Berhasil GetIngestionIndexResponseModelCollectionApiModel
Default Kesalahan ErrorResponse

Membuat Penyerapan

URL

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

Deskripsi

Permintaan penyerapan dapat memiliki payload video. Ini dapat memiliki salah satu dari tiga mode (menambahkan, memperbarui, atau menghapus). Mode tambahkan akan membuat penyerapan dan memproses video. Mode pembaruan hanya akan memperbarui metadata. Untuk memproses ulang video, penyerapan perlu dihapus dan dibuat ulang.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks tempat penyerapan akan dibuat. Ya string
ingestionName jalan Nama penyerapan yang akan dibuat. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string
body body Isi permintaan yang berisi permintaan penyerapan yang akan dibuat. Ya MembuatIngestionRequestModel

Respons

Kode Deskripsi Jenis
202 Diterima IngestionResponseModel

GetIngestion

URL

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

Deskripsi

Mendapatkan status penyerapan untuk indeks dan nama penyerapan yang ditentukan.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks yang status penyerapannya akan diperiksa. Ya string
ingestionName jalan Nama penyerapan yang akan diambil. Ya string
detailLevel pertanyaan Tingkat untuk menunjukkan tingkat detail per status penyerapan dokumen. No string
versi-api pertanyaan Versi API yang diminta. Ya string

Respons

Kode Deskripsi Jenis
200 Berhasil IngestionResponseModel
Default Kesalahan ErrorResponse

ListIngestions

URL

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

Deskripsi

Mengambil semua penyerapan untuk indeks tertentu.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks untuk mengambil penyerapan. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string

Respons

Kode Deskripsi Jenis
200 Berhasil IngestionResponseModelCollectionApiModel
Default Kesalahan ErrorResponse

ListDocuments

URL

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

Deskripsi

Mengambil semua dokumen untuk indeks tertentu.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks untuk mengambil dokumen. Ya string
$skip pertanyaan Jumlah himpunan data yang akan dilewati. No Integer
$top pertanyaan Jumlah himpunan data yang akan dikembalikan setelah dilewati. No Integer
versi-api pertanyaan Versi API yang diminta. Ya string

Respons

Kode Deskripsi Jenis
200 Berhasil IngestionDocumentResponseModelCollectionApiModel
Default Kesalahan ErrorResponse

SearchByText

URL

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

Deskripsi

Melakukan pencarian berbasis teks pada indeks yang ditentukan.

Parameter

Nama Terletak di Deskripsi Wajib Tipe
indexName jalan Nama indeks yang akan dicari. Ya string
versi-api pertanyaan Versi API yang diminta. Ya string
body body Isi permintaan yang berisi kueri dan parameter lainnya. Ya SearchQueryTextRequestModel

Respons

Kode Deskripsi Jenis
200 Berhasil SearchResultDocumentModelCollectionApiModel
Default Kesalahan ErrorResponse

Model

CreateIngestionIndexRequestModel

Mewakili model permintaan buat indeks penyerapan untuk dokumen JSON.

Nama Tipe Deskripsi Wajib diisi
metadataSchema MetadataSchemaModel No
fitur [ FeatureModel ] Mendapatkan atau mengatur daftar fitur untuk dokumen. Defaultnya adalah "visi". No
userData object Mendapatkan atau mengatur data pengguna untuk dokumen. No

MembuatIngestionRequestModel

Mewakili model permintaan penyerapan buat untuk dokumen JSON.

Nama Tipe Deskripsi Wajib diisi
video [ IngestionDocumentRequestModel ] Mendapatkan atau mengatur daftar permintaan penyerapan dokumen video dalam dokumen JSON. No
moderasi Boolean Mendapatkan atau mengatur bendera moderasi, menunjukkan apakah konten harus dimoderasi. No
generateInsightIntervals Boolean Mendapatkan atau mengatur bendera pembuatan interval, yang menunjukkan apakah interval wawasan harus dihasilkan. No
documentAuthenticationKind string Mendapatkan atau mengatur jenis autentikasi yang akan digunakan untuk mengunduh dokumen.
Enum: "none", "managedIdentity"		 No
filterDefectedFrames Boolean Bendera filter bingkai yang menunjukkan bingkai akan dievaluasi dan semua bingkai yang cacat (misalnya bingkai buram, rendah cahaya, overexposure) akan difilter. No
includeSpeechTranscript Boolean Mendapatkan atau mengatur bendera pembuatan transkrip, menunjukkan apakah transkrip harus dibuat. No

DatetimeFilterModel

Mewakili filter tanggalwaktu untuk diterapkan pada kueri pencarian.

Nama Tipe Deskripsi Wajib diisi
fieldName string Mendapatkan atau mengatur nama bidang yang akan difilter. Ya
startTime string Mendapatkan atau mengatur waktu mulai rentang untuk difilter. No
endTime string Mendapatkan atau mengatur waktu akhir rentang untuk difilter. No

ErrorResponse

Respons dikembalikan saat terjadi kesalahan.

Nama Tipe Deskripsi Wajib diisi
kesalahan ErrorResponseDetails Ya

ErrorResponseDetails

Info kesalahan.

Nama Tipe Deskripsi Wajib diisi
kode string Kode Kesalahan. Ya
pesan string Pesan kesalahan. Ya
target string Target kesalahan. No
detail [ ErrorResponseDetails ] Daftar kesalahan terperinci. No
innererror ErrorResponseInnerError No

ErrorResponseInnerError

Kesalahan terperinci.

Nama Tipe Deskripsi Wajib diisi
kode string Kode Kesalahan. Ya
pesan string Pesan kesalahan. Ya
innererror ErrorResponseInnerError No

FeatureModel

Mewakili fitur dalam indeks.

Nama Tipe Deskripsi Wajib
nama string Mendapatkan atau mengatur nama fitur.
Enum: "vision", "speech"		 Ya
modelVersion string Mendapatkan atau mengatur versi model fitur. No
domain string Mendapatkan atau mengatur domain model fitur.
Enum: "generic", "surveillance"		 No

GetIngestionIndexResponseModel

Mewakili model respons dapatkan indeks penyerapan untuk dokumen JSON.

Nama Tipe Deskripsi Wajib
nama string Mendapatkan atau mengatur properti nama indeks. No
metadataSchema MetadataSchemaModel No
userData object Mendapatkan atau mengatur data pengguna untuk dokumen. No
fitur [ FeatureModel ] Mendapatkan atau mengatur daftar fitur dalam indeks. No
eTag string Mendapatkan atau mengatur etag. Ya
createdDateTime tanggalWaktu Mendapatkan atau mengatur properti tanggal dan waktu yang dibuat. Ya
lastModifiedDateTime tanggalWaktu Mendapatkan atau mengatur properti tanggal dan waktu terakhir yang dimodifikasi. Ya

GetIngestionIndexResponseModelCollectionApiModel

Berisi array hasil yang mungkin dipaginasi.

Nama Tipe Deskripsi Wajib diisi
value [ GetIngestionIndexResponseModel ] Array hasil. Ya
NextLink string Tautan ke kumpulan hasil paginasi berikutnya, jika ada lebih banyak hasil yang tersedia; tidak ada jika tidak. No

IngestionDocumentRequestModel

Mewakili permintaan penyerapan dokumen video dalam dokumen JSON.

Nama Tipe Deskripsi Wajib diisi
mode string Mendapatkan atau mengatur mode penyerapan untuk dokumen.
Enum: "add", "update", "remove"		 Ya
documentId string Mendapatkan atau mengatur ID dokumen. No
documentUrl string (uri) Mendapatkan atau mengatur URL dokumen. Tanda tangan akses bersama (SAS), jika ada, akan dihapus dari URL. Ya
metadata object Mendapatkan atau mengatur metadata untuk dokumen sebagai kamus pasangan nama-nilai. No
userData object Mendapatkan atau mengatur data pengguna untuk dokumen. No

IngestionDocumentResponseModel

Mewakili objek respons dokumen penyerapan dalam dokumen JSON.

Nama Tipe Deskripsi Wajib diisi
documentId string Mendapatkan atau mengatur ID dokumen. No
documentUrl string (uri) Mendapatkan atau mengatur URL dokumen. Tanda tangan akses bersama (SAS), jika ada, akan dihapus dari URL. No
metadata object Mendapatkan atau mengatur pasangan kunci-nilai metadata. No
kesalahan ErrorResponseDetails No
createdDateTime tanggalWaktu Mendapatkan atau mengatur tanggal dan waktu dokumen yang dibuat. No
lastModifiedDateTime tanggalWaktu Mendapatkan atau mengatur tanggal dan waktu terakhir dokumen yang dimodifikasi. No
userData object Mendapatkan atau mengatur data pengguna untuk dokumen. No

IngestionDocumentResponseModelCollectionApiModel

Berisi array hasil yang mungkin dipaginasi.

Nama Tipe Deskripsi Wajib diisi
value [ IngestionDocumentResponseModel ] Array hasil. Ya
NextLink string Tautan ke kumpulan hasil paginasi berikutnya, jika ada lebih banyak hasil yang tersedia; tidak ada jika tidak. No

IngestionErrorDetailsApiModel

Mewakili informasi kesalahan penyerapan untuk setiap dokumen.

Nama Tipe Deskripsi Wajib diisi
kode string Kode Kesalahan. No
pesan string Pesan kesalahan. No
innerError IngestionInnerErrorDetailsApiModel No

IngestionInnerErrorDetailsApiModel

Mewakili informasi kesalahan dalam penyerapan untuk setiap dokumen.

Nama Tipe Deskripsi Wajib diisi
kode string Kode Kesalahan. No
pesan string Pesan kesalahan. No
innerError IngestionInnerErrorDetailsApiModel No

IngestionResponseModel

Mewakili model respons penyerapan untuk dokumen JSON.

Nama Tipe Deskripsi Wajib
nama string Mendapatkan atau mengatur nama penyerapan. No
state string Mendapatkan atau mengatur status penyerapan.
Enum: "notStarted", "running", "completed", "failed", "partiallySucceeded"		 No
kesalahan ErrorResponseDetails No
batchName string Nama batch yang terkait dengan penyerapan ini. No
createdDateTime tanggalWaktu Mendapatkan atau mengatur tanggal dan waktu penyerapan yang dibuat. No
lastModifiedDateTime tanggalWaktu Mendapatkan atau mengatur tanggal dan waktu terakhir yang dimodifikasi dari penyerapan. No
fileStatusDetails [ IngestionStatusDetailsApiModel ] Daftar status penyerapan untuk setiap dokumen. No

IngestionResponseModelCollectionApiModel

Berisi array hasil yang mungkin dipaginasi.

Nama Tipe Deskripsi Wajib diisi
value [ PenyerapanResponseModel ] Array hasil. Ya
NextLink string Tautan ke kumpulan hasil paginasi berikutnya, jika ada lebih banyak hasil yang tersedia; tidak ada jika tidak. No

IngestionStatusDetailsApiModel

Mewakili detail status penyerapan untuk setiap dokumen.

Nama Tipe Deskripsi Wajib diisi
lastUpdateTime tanggalWaktu Waktu pembaruan status dari gugus batch. Ya
documentId string ID Dokumen. Ya
documentUrl string (uri) Url dokumen. No
berhasil Boolean Bendera untuk menunjukkan apakah inferensi berhasil. Ya
kesalahan IngestionErrorDetailsApiModel No

MetadataSchemaFieldModel

Mewakili bidang dalam skema metadata.

Nama Tipe Deskripsi Wajib
nama string Mendapatkan atau mengatur nama bidang. Ya
dapat dicari Boolean Mendapatkan atau menetapkan nilai yang menunjukkan apakah bidang dapat dicari. Ya
dapat difilter Boolean Mendapatkan atau menetapkan nilai yang menunjukkan apakah bidang dapat difilter. Ya
jenis string Mendapatkan atau mengatur jenis bidang. Ini bisa berupa string atau tanggalwaktu.
Enum: "string", "datetime"		 Ya

MetadataSchemaModel

Mewakili skema metadata untuk dokumen.

Nama Tipe Deskripsi Wajib diisi
bahasa string Mendapatkan atau mengatur bahasa skema metadata. Defaultnya adalah "en". No
fields [ MetadataSchemaFieldModel ] Mendapatkan atau mengatur daftar bidang dalam skema metadata. Ya

SearchFiltersModel

Mewakili filter yang akan diterapkan pada kueri pencarian.

Nama Tipe Deskripsi Wajib diisi
stringFilters [ StringFilterModel ] Mendapatkan atau mengatur filter string yang akan diterapkan pada kueri pencarian. No
datetimeFilters [ DatetimeFilterModel ] Mendapatkan atau mengatur filter tanggalwaktu untuk diterapkan pada kueri pencarian. No
featureFilters [ string ] Mendapatkan atau mengatur filter fitur yang akan diterapkan pada kueri pencarian. No

SearchQueryTextRequestModel

Mewakili model permintaan kueri pencarian untuk pencarian berbasis teks.

Nama Tipe Deskripsi Wajib diisi
queryText string Mendapatkan atau mengatur teks kueri. Ya
filter SearchFiltersModel No
moderasi Boolean Mendapatkan atau menetapkan nilai boolean yang menunjukkan apakah moderasi diaktifkan atau dinonaktifkan. No
atas Integer Mendapatkan atau mengatur jumlah hasil yang akan diambil. Ya
skip Integer Mendapatkan atau mengatur jumlah hasil yang akan dilewati. Ya
additionalIndexNames [ string ] Mendapatkan atau mengatur nama indeks tambahan untuk disertakan dalam kueri pencarian. No
dedup Boolean Apakah akan menghapus bingkai video serupa. Ya
dedupMaxDocumentCount Integer Jumlah maksimum dokumen setelah dedup. Ya
disableMetadataSearch Boolean Mendapatkan atau mengatur nilai boolean yang menunjukkan apakah metadata dinonaktifkan dalam pencarian atau tidak. Ya

SearchResultDocumentModel

Mewakili respons kueri pencarian.

Nama Tipe Deskripsi Wajib diisi
documentId string Mendapatkan atau mengatur ID dokumen. No
documentKind string Mendapatkan atau mengatur jenis dokumen, yang bisa menjadi "video". No
mulai string Mendapatkan atau mengatur waktu mulai dokumen. Properti ini hanya berlaku untuk dokumen video. No
akhir string Mendapatkan atau mengatur waktu akhir dokumen. Properti ini hanya berlaku untuk dokumen video. No
terbaik string Mendapatkan atau mengatur tanda waktu dokumen dengan skor relevansi tertinggi. Properti ini hanya berlaku untuk dokumen video. No
Relevansi ganda Mendapatkan atau mengatur skor relevansi dokumen. Ya
additionalMetadata object Mendapatkan atau mengatur metadata tambahan yang terkait dengan pencarian. No

SearchResultDocumentModelCollectionApiModel

Berisi array hasil yang mungkin dipaginasi.

Nama Tipe Deskripsi Wajib diisi
value [ SearchResultDocumentModel ] Array hasil. Ya
NextLink string Tautan ke kumpulan hasil paginasi berikutnya, jika ada lebih banyak hasil yang tersedia; tidak ada jika tidak. No

StringFilterModel

Mewakili filter string untuk diterapkan pada kueri pencarian.

Nama Tipe Deskripsi Wajib diisi
fieldName string Mendapatkan atau mengatur nama bidang yang akan difilter. Ya
nilai [ string ] Mendapatkan atau mengatur nilai untuk difilter. Ya

UpdateIngestionIndexRequestModel

Mewakili model permintaan indeks penyerapan pembaruan untuk dokumen JSON.

Nama Tipe Deskripsi Wajib diisi
metadataSchema MetadataSchemaModel No
userData object Mendapatkan atau mengatur data pengguna untuk dokumen. No