Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Titik Akhir:POST https://api.microsoft.ai/v3/search/videos
Permintaan Sampel:
curl -X POST "https://api.microsoft.ai/v3/search/videos" \
-H "host: api.microsoft.ai" \
-H "x-apikey: <Your key>" \
-H "content-type: application/json" \
-d '{
"query": "cute puppy videos",
"maxResults": 30,
"language": "en",
"region": "US"
}'
Parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| kueri | Yes | string | - | String kueri pencarian. Panjang maksimum adalah 1000 karakter. |
| maxResults | No | integer | 30 | Jumlah maksimum hasil yang akan dikembalikan. Defaultnya adalah 30 dan nilai maksimum adalah 30. |
| language | No | string | "en" | Kode bahasa ISO 639-1 2 huruf untuk bahasa antarmuka dalam hasil pencarian. Lihat Bahasa yang Didukung untuk daftar lengkapnya. |
| region | No | string | "US" | Kode negara/wilayah 2 huruf tempat hasilnya harus berasal (misalnya "US", "JP", "GB", dll.). Lihat Wilayah yang Didukung untuk daftar lengkapnya. |
| enablePlaylist | No | Boolean | tidak benar | Apakah akan menyertakan hasil daftar putar sebagai respons. |
| freshness | No | string | - | Rentang waktu untuk memfilter hasil berdasarkan tanggal penemuan. Mendukung "minggu", "bulan", "tahun" untuk waktu relatif, atau format interval tanggal ISO 8601: "YYYY-MM-DD/YYYY-MM-DD" atau "YYYY-MM-DDTHH:mm:ssZ/YYYY-MM-DDTHH:mm:ssZ" untuk rentang tanggal/tanggalwaktu, gunakan .. untuk menghilangkan tanggal mulai atau berakhir. |
| dapat disematkan | No | array dari string | - | Memfilter video dengan menyematkan kemampuan. Nilai yang diizinkan: "pemutar" (memiliki pemutar yang dapat disematkan). Saat tidak diatur, tidak ada pemfilteran yang diterapkan. |
| resolusi | No | string | - | Memfilter video menurut resolusi minimum . Nilai: "360p", "480p", "720p", "1080p". Saat tidak diatur, tidak ada pemfilteran yang diterapkan. |
| safeSearch | No | string | "ketat" | Tingkat pemfilteran pencarian yang aman. Nilai: "off", "strict". Defaultnya adalah "ketat". |
| duration | No | string | - | Memfilter video menurut rentang durasi. Nilai: "pendek" (<5 menit), "sedang" (5–20 menit), "panjang" (>20 menit). Saat tidak diatur, tidak ada pemfilteran yang diterapkan. |
Header Permintaan
| Field | Type | Description |
|---|---|---|
| host | string | Host untuk API AI Microsoft: api.microsoft.ai. |
| x-apikey atau Otorisasi | string | Kunci API Anda atau token akses Entra ID untuk autentikasi. |
| jenis konten | string | Jenis MIME isi permintaan. Gunakan application/json. |
Jawaban
Respons Video
| Field | Type | Description |
|---|---|---|
| videoResults | array videoResult | Daftar hasil video. |
| daftar putar | array playlistResult (opsional) | Daftar hasil daftar putar. |
| instrumentationClickBase | string | URL Dasar untuk mengeklik permintaan ping. Tambahkan instrumentationSuffix nilai dari item hasil untuk membentuk URL ping lengkap. Hanya ada untuk aplikasi dengan bendera profil EnableInstrumentationPing. Catatan: Klik pengguna juga dapat dicatat menggunakan pengalihan URL. Ketika pengalihan diaktifkan, tidak ada tindakan yang diperlukan untuk mencatat klik Pengguna, dan instrumentationClickBase tidak akan disertakan dalam respons. Lihat Panduan instrumentasi untuk instruksi penyiapan. |
| instrumentationCitationBase | string | URL Dasar untuk permintaan ping log LLM. Tambahkan payload DATA untuk membentuk URL ping lengkap. Hanya ada untuk aplikasi dengan bendera profil EnableInstrumentationPing. |
| traceId | string | ID pelacakan untuk penelusuran kesalahan. |
Note
playlists adalah bidang opsional bahkan ketika enablePlaylist diatur ke true.
videoResult
| Field | Type | Description |
|---|---|---|
| title | string | Judul atau nama video. |
| url | string | URL sumber video. Untuk pengguna Tiongkok dengan pengalihan URL diaktifkan, bidang ini sebagai gantinya berisi URL pengalihan yang sama dengan clickUrl. |
| domain | string | Host tujuan untuk hasilnya. Dikembalikan hanya untuk pengguna Tiongkok dengan pengalihan URL diaktifkan. |
| description | string | Deskripsi konten video. Ini disediakan oleh pengunggah video atau dihasilkan oleh LLM. |
| publishedBy | string | Pengunggah atau penerbit video. |
| viewCount | long | Jumlah penayangan yang dimiliki video. |
| summary | string | Ringkasan video yang dihasilkan AI. |
| length | string | Panjang video dalam format HH:MM:SS. |
| allowHttpsEmbedding | Boolean | Apakah penyematan HTTPS diizinkan. |
| allowMobileEmbedding | Boolean | Apakah penyematan seluler diizinkan. |
| embeddingUrl | string | URL untuk menyematkan video. |
| terakhirDiperbaruiPada | string | Tanggal terakhir diperbarui sebagai string yang diformat. |
| bestMomentIndex | integer | Indeks momen atau sorotan terbaik dalam video. |
| Saat | array momen | Array segmen/momen video. |
| thumbnailUrl | string | URL gambar mini video. |
| width | integer | Lebar video dalam piksel. |
| height | integer | Tinggi video dalam piksel. |
| isAdult | Boolean | Menunjukkan apakah hasilnya menyertakan konten dewasa. |
| klikUrl | string | Alihkan URL yang memproksi klik melalui Bing. Hanya ada saat pengalihan klik diaktifkan. |
| instrumentationSuffix | string | Akhiran untuk ditambahkan ke basis URL ping instrumentasi untuk item hasil ini. Digunakan sebagai nilai K untuk URL ping instrumentasi dan clickUrl pengalihan. Ada saat ping instrumentasi diaktifkan. |
Note
Beberapa bidang di atas bersifat opsional – bidang tersebut dilayani jika tersedia.
momen
| Field | Type | Description |
|---|---|---|
| title | string | Judul segmen momen. |
| description | string | Deskripsi tentang apa yang terjadi di saat ini. |
| startTime | string | Waktu mulai saat dalam format 'd.hh:mm:ss'. |
| endTime | string | Waktu akhir momen dalam format 'd.hh:mm:ss'. |
| momentUrl | string | URL langsung ke momen spesifik ini dalam video. |
Note
moment adalah objek respons opsional. Ini tidak tersedia untuk setiap hasil video.
playlistResult
| Field | Type | Description |
|---|---|---|
| title | string | Judul daftar putar. |
| description | string | Deskripsi daftar putar. |
| video | array video | Array video dalam daftar putar. |
Note
playlistResult adalah objek respons opsional.
video
| Field | Type | Description |
|---|---|---|
| title | string | Judul video. |
| description | string | Deskripsi video. |
| url | string | URL dari video. |
Kode Kesalahan
| Kode Status | Kategori Kesalahan | Description | Penyebab Umum |
|---|---|---|---|
| 200 | Keberhasilan | Permintaan itu berhasil. | - |
| 400 | Permintaan Tidak Valid | Parameter permintaan tidak valid. | Bidang yang diperlukan hilang, nilai parameter tidak valid, JSON cacat |
| 401 | Unauthorized | Autentikasi gagal atau hilang. | Kunci API tidak valid, header x-apikey hilang |
| 403 | Forbidden | Kredensial yang valid tetapi izinnya tidak mencukup. | Kunci API tidak memiliki izin yang diperlukan |
| 410 | Hilang | HTTPS diperlukan. | Permintaan yang dibuat melalui HTTP alih-alih HTTPS |
| 415 | Tipe Media yang Tidak Didukung | Tipe isi tidak didukung. | Header tipe konten yang hilang atau salah |
| 429 | Terlalu Banyak Permintaan | Batas kecepatan terlampaui. | Terlalu banyak permintaan dalam jendela waktu |
| 500 | Kesalahan Server Internal | Kesalahan server tak terduga. | Masalah server sementara |
| 503 | Layanan Tidak Tersedia | Layanan untuk sementara tidak tersedia. | Pemeliharaan atau pemadaman sementara |
| 504 | Waktu Habis Gateway | Waktu permintaan berakhir. | Batas waktu layanan upstram |
Untuk panduan penanganan kesalahan terperinci, lihat Penanganan Kesalahan.
Lihat juga:Pencarian | WebTelusuri | GambarPencarian | BeritaMCP |