- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- Izin IAM
- SchemaKeySortingStrategy
- Opsi
- AggregateMethod
- FacetGroup
- FacetBucket
- Rentang
Menelusuri aset media.
Permintaan HTTP
POST https://visionai.googleapis.com/v1/{corpus=projects/*/locations/*/corpora/*}:searchAssets
URL menggunakan sintaks gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
corpus |
Wajib. Korpus induk yang akan ditelusuri. Format: `projects/{projectId}/locations/{locationId}/corpora/{corpus_id}' |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "pageSize": integer, "pageToken": string, "contentTimeRanges": { object ( |
Kolom | |
---|---|
pageSize |
Jumlah hasil yang akan ditampilkan di halaman ini. Jika 0, server akan menentukan pageSize yang sesuai. |
pageToken |
Token lanjutan untuk mengambil halaman berikutnya. Jika kosong, berarti halaman pertama sedang diambil. |
contentTimeRanges |
Rentang waktu yang harus sesuai dengan konten video. Jika tidak ada rentang yang diberikan, tidak akan ada batasan waktu. Kolom ini diperlakukan sama seperti kriteria di bawah, tetapi ditentukan secara terpisah untuk memudahkan karena sering digunakan. Perhatikan bahwa jika endTime adalah tanggal yang akan datang, nilainya akan dibatasi ke waktu permintaan diterima. |
criteria[] |
Kriteria yang diterapkan ke hasil penelusuran. |
exclusionCriteria[] |
Kriteria yang akan dikecualikan dari hasil penelusuran. Perhatikan bahwa |
facetSelections[] |
Menyimpan status pemilihan faset terbaru. Hanya grup aspek dengan pilihan pengguna yang akan ditampilkan di sini. Status pilihan dipilih atau tidak dipilih. Hanya bucket faset yang dipilih yang akan digunakan sebagai kriteria penelusuran. |
resultAnnotationKeys[] |
Daftar kunci anotasi untuk menentukan anotasi yang akan diambil dan ditampilkan dengan setiap hasil penelusuran. Tingkat perincian anotasi harus GRANULARITY_ASSET_LEVEL dan strategi penelusurannya tidak boleh NO_SEARCH. |
searchQuery |
Kueri penelusuran global. Memungkinkan pengguna menelusuri aset tanpa perlu menentukan kolom tempat nilai berada. |
Kolom union sort_spec . Spesifikasi pengurutan. Jika kolom ini tidak ditentukan, secara default: - STREAM_VIDEO: hasil penelusuran diurutkan berdasarkan waktu mulai. sort_spec hanya ada berupa salah satu diantara berikut: |
|
schemaKeySortingStrategy |
Urutkan menurut nilai di bagian kunci skema data. |
Isi respons
Pesan respons untuk corpora.searchAssets.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "searchResultItems": [ { object ( |
Kolom | |
---|---|
searchResultItems[] |
Menampilkan hasil penelusuran. |
nextPageToken |
Token lanjutan halaman berikutnya. |
facetResults[] |
Hasil penelusuran faset dari kueri tertentu, yang berisi nilai faset yang telah dipilih pengguna dan hasil penelusuran faset yang diperbarui. |
Cakupan otorisasi
Memerlukan cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud-platform
Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.
Izin IAM
Memerlukan izin IAM berikut pada resource corpus
:
visionai.assets.search
Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.
SchemaKeySortingStrategy
Strategi untuk menentukan cara mengurutkan menurut kunci skema data.
Representasi JSON |
---|
{
"options": [
{
object ( |
Kolom | |
---|---|
options[] |
Opsi di bagian depan memiliki prioritas tinggi daripada opsi di bagian belakang. |
Opsi
Opsi untuk satu kunci skema data.
Representasi JSON |
---|
{
"dataSchemaKey": string,
"sortDecreasing": boolean,
"aggregateMethod": enum ( |
Kolom | |
---|---|
dataSchemaKey |
Data yang digunakan untuk mengurutkan. |
sortDecreasing |
Apakah akan mengurutkan dalam urutan menurun atau menaik. Secara default, hasil diurutkan dalam urutan menaik. |
aggregateMethod |
Metode agregat untuk kunci skema data saat ini. |
AggregateMethod
Jika satu hasil memiliki beberapa nilai dengan kunci yang sama, tentukan nilai yang digunakan untuk mengurutkan. Secara default, AGGREGATE_METHOD_LARGEST digunakan saat hasil diurutkan dalam urutan menurun, AGGREGATE_METHOD_SMALLEST digunakan saat hasil diurutkan dalam urutan menaik.
Enum | |
---|---|
AGGREGATE_METHOD_UNSPECIFIED |
Metode agregat yang tidak ditentukan akan ditimpa seperti yang disebutkan di atas. |
AGGREGATE_METHOD_LARGEST |
Ambil nilai terbesar (leksikal atau numerik) untuk diurutkan. |
AGGREGATE_METHOD_SMALLEST |
Ambil nilai terkecil (leksikal atau numerik) untuk diurutkan. |
FacetGroup
Sekelompok bucket facet yang akan diteruskan bolak-balik antara backend & frontend.
Representasi JSON |
---|
{ "facetId": string, "displayName": string, "buckets": [ { object ( |
Kolom | |
---|---|
facetId |
ID unik grup aspek. |
displayName |
Nama tampilan faset. Untuk digunakan oleh UI untuk rendering faset. |
buckets[] |
Bucket yang terkait dengan facet. Misalnya, untuk faset "Tim", bucket-nya dapat berupa 49ers, patriots, dll. |
bucketType |
Jenis bucket faset. |
fetchMatchedAnnotations |
Jika benar, tampilkan anotasi yang cocok dengan kueri untuk pilihan grup aspek ini. Opsi ini hanya berlaku untuk facet berdasarkan anotasi tingkat partisi. Kode ini mendukung nilai aspek berikut: - INTEGER - STRING (khusus DataSchema.SearchStrategy.EXACT_SEARCH) |
FacetBucket
Menyimpan nilai faset, status pilihan, dan metadata.
Representasi JSON |
---|
{ "selected": boolean, // Union field |
Kolom | |
---|---|
selected |
Apakah satu bucket facet dipilih. Kolom ini mewakili pilihan aspek pengguna. Nilai ini ditetapkan oleh frontend di SearchVideosRequest. |
Kolom union bucket_value . Bucket yang terkait dengan facet. Misalnya, bucket faset "team" dapat berupa "49ers", "patriots", dll.; bucket faset "player" dapat berupa "tom brady", "drew brees", dll. bucket_value hanya dapat berupa salah satu dari hal berikut: |
|
value |
Nilai singular. |
range |
Nilai rentang. |
Rentang
Rentang nilai [start, end) yang akan diterapkan pemetaan facet.
Representasi JSON |
---|
{ "start": { object ( |
Kolom | |
---|---|
start |
Awal rentang. Tidak adanya menunjukkan beberapa batas (misalnya -inf). |
end |
Akhir rentang. Tidak adanya menunjukkan beberapa batas (misalnya inf). |