Model Pengenal Produk membantu Anda mengenali dan memahami produk yang ada dalam gambar yang diberikan. Gambar hanya boleh berisi satu item produk yang ingin Anda kenali.
Model ini dapat berfungsi sebagai elemen dasar AI utama untuk menganalisis dan menafsirkan data gambar produk, yang dapat Anda ambil dari toko retail.
Kasus penggunaan Pengenal Tag dan Pengenal Produk
Model Product Recognizer dan Tag Recognizer dapat berfungsi sebagai elemen penyusun AI utama untuk menganalisis dan menafsirkan data gambar di sekitar data gambar produk dan tag, yang mungkin telah Anda ambil dari toko retail.
Model Pengenal produk dan Pengenal tag menggabungkan beberapa kemampuan pemodelan dan data AI inti Google untuk membantu retailer dan/atau partner teknis memecahkan masalah utama dalam memahami data gambar produk dan label harga, termasuk:
- Mengenali, sehingga memahami produk apa yang ada dalam gambar.
- Mengenali dan mengurai tag (misalnya, tag harga, atau tag label teks lainnya) sesuai dengan skema ekstraksi entitas key-value pair yang ditentukan pengguna.
Secara khusus, beberapa model AI Google yang berbeda disertakan untuk mendukung pemecahan masalah kasus penggunaan ini, seperti
- Model penyematan visual thumbnail produk, yang mengubah gambar thumbnail produk menjadi representasi ruang fitur numerik.
- Model OCR Google, yang mengekstrak semua teks yang terlihat dalam gambar.
- Model ekstraksi entitas Google (yang dapat Anda sesuaikan), yang mengubah teks mentah menjadi entitas bernama pasangan nilai kunci yang ditentukan pengguna.
Selain model AI Google ini, pengenal produk juga memanfaatkan database besar informasi produk Google. Data produk dalam database Produk ini mencakup identitas GTIN / UPC produk, merek produk, judul, dan deskripsi lintas bahasa, logo produk, serta gambar dengan berbagai variasi kemasan. Model embedding visual thumbnail produk dengan database Produk yang disebutkan sebelumnya memungkinkan model Pengenal produk dapat mengenali banyak produk secara langsung.
Dua fitur AI utama adalah model Product Recognizer dan Tag Recognizer.
Fungsi Product Recognizer
Model ini mengenali identitas produk individual di tingkat Nomor Barang Perdagangan Global (GTIN) atau tingkat Kode Produk Universal (UPC). Beberapa model AI Google yang berbeda disertakan dalam Pengenal Produk untuk mendukung pemecahan masalah kasus penggunaan ini, seperti:
- Model penyematan visual produk, yang mengubah gambar produk menjadi representasi ruang fitur numerik.
- Teknologi OCR Google, yang mengekstrak semua teks yang terlihat dalam gambar.
- Database produk Google yang digunakan bersama dengan model embedding visual thumbnail produk memungkinkan model Pengenal Produk mengenali banyak produk secara langsung.
Contoh Objek JSON Output
{
"imageUri": "gs://test_bucket/test_image.jpg",
"productRecognitionAnnotations": [
{
"detectedText": "Bolthouse Farms Perfectly Protein Tea & Soy Beverage",
"recognitionResults": [
{
"confidence": 0.9420832,
"productMetadata": {
"brand": "Bolthouse Farms",
"gtins": [
"00071464260804"
],
"locale": "en-US",
"title": "Bolthouse Farms Perfectly Protein Tea & Soy Beverage, Vanilla Chai Tea - 52 fl oz"
},
}
]
}
]
}Konsep API
Ada enam resource API yang ditawarkan untuk membantu membangun katalog produk, pengelolaan set data produk, pembuatan indeks, dan deployment untuk layanan Pengenalan Produk. Berikut penjelasannya:

Katalog: Resource root yang merepresentasikan penampung untuk semua produk yang ditawarkan oleh retailer.
Produk: Mewakili produk yang ditawarkan oleh penjual. Product adalah resource
turunan dari Catalog.
ProductImage: Gambar yang menampilkan tampilan satu produk. ProductImage
adalah resource turunan dari Product.
ProductSet: Container dengan perincian yang lebih baik untuk mengatur dan mengelompokkan produk dalam
Catalog yang sama. Satu ProductSet dapat berisi satu atau banyak Product, tetapi ProductSet tersebut tidak "memiliki" Product yang ada di dalamnya, melainkan mempertahankan "link" ke Product tersebut.
ProductRecognitionIndex: Berisi daftar penyematan gambar yang digunakan untuk algoritma pengenalan produk. ProductRecognitionIndex dapat dibuat dari
seluruh Catalog atau dari ProductSet (subset Product dari
Catalog).
Endpoint: Penempatan yang memuat semua konfigurasi yang diperlukan untuk
melakukan inferensi Pengenalan Produk atau Pengenalan Tag. Untuk Pengenalan
Produk, ProductRecognitionIndex harus di-deploy.
Untuk Pengenalan Tag, model penguraian entity tag harus ditentukan.
Penyiapan lingkungan
Bagian ini menjelaskan cara berinteraksi dengan Store Vision AI RESTful API.
API_ENDPOINT=visionai.googleapis.com
PROJECT_ID=your project ID
Semua metode create memerlukan penentuan
nama/ID resource yang akan dibuat secara eksplisit. Anda dapat menggunakan ID string yang bermakna, misalnya, "product-ABC" atau ID yang dibuat secara acak, misalnya,
UUID.
Untuk memberikan akses editor peran kepada seseorang agar dapat menggunakan Store Vision API, jalankan perintah pengikatan IAM berikut:
gcloud projects add-iam-policy-binding PROJECT_ID --member='user:USER_ACCOUNT' --role='roles/visionai.editor'
Untuk memberikan akses editor ke akun layanan, gunakan perintah di bawah:
gcloud projects add-iam-policy-binding PROJECT_ID --member='serviceAccount:SERVICE_ACCOUNT' --role='roles/visionai.editor'
Pelajari lebih lanjut pengikatan IAM.
Perjalanan pengguna Product Recognizer
- Buat Katalog.
- Impor Produk dan (opsional)
ProductImageskeCatalog. - Lihat dan ubah
ProductdanProductImages, dan secara opsional buatProductSetuntuk mengatur daftar produk dengan perincian yang lebih baik. - Buat
Index, baik dari seluruhCatalogatau dariProductSet. - Membuat
Endpointdengan konfigurasi pengenalan produk yang diinginkan dan men-deployIndexke dalamnya. - Lakukan
BatchAnalyzedengan fiturProductRecognition. Di backend, sistem akan mengidentifikasi produk dari setiap gambar input dan mengambil K produk serupa teratas dari indeks yang ditentukan menggunakan sinyal visual dan teks OCR.
Pengelolaan resource API (Katalog dan Indexset)
Katalog
Buat Katalog
- CATALOG_ID=ID katalog Anda.
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{}' https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs?retail_catalog_id=CATALOG_ID
Contoh output
{
"name": "projects/cloud-store-vision-test/locations/us-central1/operations/operation-1655157982362-5e15b7f95fa6f-d30364c6-dc3a3714",
"done": false
}
Tarik Operasi hingga selesai
- OPERATION_ID=Operasi output Anda, misalnya, operation-1655157982362-5e15b7f95fa6f-d30364c6-dc3a3714
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/operations/OPERATION_ID
Contoh output
{
"name": "projects/cloud-store-vision-test/locations/us-central1/operations/operation-1655157982362-5e15b7f95fa6f-d30364c6-dc3a3714",
"done": true
}
ImportProduct
Ada dua format impor yang didukung:
- TXT: setiap baris adalah gtin Produk yang akan diimpor
- JSONL: setiap baris adalah format JSON RetailProductIoFormat, misalnya,
{"retailProduct":{"name":"00040094314034","gtins":["00040094314034"]},"retailProductImages":[{"name":"1","gcsUri":"gs://shelfchecking-integration-test-data/products-data/00040094314034/1.jpg"}]}
{"retailProduct": {"name":"00123", "thirdPartyIds": {"id": "test-id", "owner": "test-owner"}}}
Lihat referensi API untuk mengetahui detail selengkapnya tentang RetailProductIoFormat. Saat ini,kami mendukung impor maksimum 10.000 produk per operasi ImportProduct.
Perhatikan juga bahwa "name" dalam "retailProductImages" hanya perlu bersifat unik dalam cakupan resource "retailProduct" induk, yang berarti dapat ada 2 "retailProductImages" dengan "name" yang sama selama keduanya termasuk dalam resource "retailProduct" yang berbeda.
- IMPORT_FILE_URI=URI Cloud Storage file impor Anda, misalnya, gs://mybucket/my_import_file.jsonl
- IMPORT_FORMAT=Format file impor Anda, FORMAT_JSONL atau FORMAT_TXT
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID:importRetailProducts \
-d '{
"gcs_source": {
"uris": "IMPORT_FILE_URI"
},
"format": "IMPORT_FORMAT"
}'
Mencantumkan Katalog
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs
GetCatalog
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID
DeleteCatalog
curl -sS -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID
Produk
CreateProduct dengan GTIN
Kami mendukung format GTIN-8, GTIN-13, GTIN-14, dan UPC(juga dikenal sebagai GTIN-12). Pelajari format GTIN lebih lanjut di sini.
- PRODUCT_ID=ID produk Anda
- GTIN=GTIN produk Anda, misalnya, 50735854797459, 00040094314034
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts?retail_product_id=PRODUCT_ID \
-d '{"gtins": "GTIN"}'
CreateProduct dengan ID Pihak Ketiga
- PRODUCT_ID=ID produk Anda
- THIRD_PARTY_ID=ID pihak ketiga
- OWNER=Entitas yang memiliki ID pihak ketiga
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts?retail_product_id=PRODUCT_ID \
-d '
{
"third_party_ids": {
"id": "THIRD_PARTY_ID",
"owner": "OWNER",
}
}'
ListProducts
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts
GetProducts
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts/PRODUCT_ID
DeleteProduct
curl -sS -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts/PRODUCT_ID
ProductImage
CreateProductImage
- PRODUCT_IMAGE_ID=ID gambar produk Anda
- IMAGE_GCS_URI=URI Cloud Storage gambar Anda, misalnya, gs://mybucket/my_img.jpg
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts/PRODUCT_ID/retailProductImages?retail_product_image_id=PRODUCT_IMAGE_ID \
-d '{
"source_type": "SOURCE_TYPE_HAND_HELD_CAMERA",
"gcs_uri": "IMAGE_GCS_URI"
}'
ListProductImages
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts/PRODUCT_ID/retailProductImages
GetProductImages
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts/PRODUCT_ID/retailProductImages/PRODUCT_IMAGE_ID
DeleteProductImage
curl -sS -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProducts/PRODUCT_ID/retailProductImages/PRODUCT_IMAGE_ID
ProductSet
CreateProductSet
- PRODUCT_SET_ID=ID set produk Anda
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{}' https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductSets?retail_product_set_id=PRODUCT_SET_ID
ListProductSet
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductSets
GetProductSet
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductSets/PRODUCT_SET_ID
AddProductsToProductSet
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductSets/PRODUCT_SET_ID:add \
-d '{"product_ids": "PRODUCT_ID"}'
RemoveProductsFromProductSet
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductSets/PRODUCT_SET_ID:remove \
-d '{"product_ids": "PRODUCT_ID"}'
DeleteProductSet
curl -sS -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductSets/PRODUCT_SET_ID
ProductRecognitionIndex
Create ProductRecognitionIndex
Ada dua cara untuk membuat ProductRecognitionIndex, baik dari Katalog yang akan menggunakan semua yang ada dalam Katalog ini, atau dari ProductSet yang hanya akan menggunakan produk dan gambar produk terkait.
- INDEX_ID=ID indeks Anda
- COVERAGE_CSV_OUTPUT_DIRECTORY=<Lokasi Cloud Storage dari direktori tempat file cakupan indeks akan ditulis
# Create from Catalog
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductRecognitionIndexes?retail_product_recognition_index_id=INDEX_ID
# Create from Catalog and output index coverage CSV file to a Cloud Storage directory.
# This API method is especially useful when you want to understand the
# actual number of images used to construct the index per imported GTIN, and
# the image can be sourced from the Google Product database, your own importing,
# and other means (such as with the Google Data Labeling service.
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" "https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductRecognitionIndexes?retail_product_recognition_index_id=INDEX_ID&coverage_output.output_uri_prefix=COVERAGE_CSV_OUTPUT_DIRECTORY"
# Create from ProductSet, by adding the following to the previous Curl command
-d '{"retail_product_set": "projects/PROJECT_ID/locations/us-central1/retailCatalogs/'CATALOG_ID'/retailProductSets/PRODUCT_SET_ID"}'
Get ProductRecognitionIndex
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductRecognitionIndexes/INDEX_ID
Mencantumkan ProductRecognitionIndex
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductRecognitionIndexes
Delete ProductRecognitionIndex
curl -sS -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailCatalogs/CATALOG_ID/retailProductRecognitionIndexes/INDEX_ID
Endpoint
Membuat Endpoint
- ENDPOINT_ID=ID endpoint Anda
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints?retail_endpoint_id=ENDPOINT_ID -d '{
"productRecognitionConfig": {
"recognitionConfidenceThreshold": 0.4
}
}'
DeployProductRecognitionIndex
Endpoint hanya dapat di-deploy dengan satu ProductRecognitionIndex, tetapi satu ProductRecognitionIndex dapat di-deploy ke beberapa Endpoint.
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints/ENDPOINT_ID:deployRetailProductRecognitionIndex \
-d '{
"retail_product_recognition_index": "projects/PROJECT_ID/locations/us-central1/retailCatalogs/'CATALOG_ID'/retailProductRecognitionIndexes/INDEX_ID"
}'
GetEndpoint
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints/ENDPOINT_ID
ListEndpoints
curl -sS -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints
UndeployProductRecognitionIndex
Membatalkan deployment hanya akan menghapus ProductRecognitionIndex yang di-deploy dari Endpoint panggilan saat ini, dan tidak akan memengaruhi Endpoint lain jika ProductRecognitionIndex ini juga di-deploy ke Endpoint lain.
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints/ENDPOINT_ID:undeployRetailProductRecognitionIndex
DeleteEndpoint
curl -sS -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints/ENDPOINT_ID
Inferensi Analisis Batch (Pengenalan Produk)
Contoh file input di gs://my-bucket/input-file.csv:
gs://my-bucket/my-image1.jpg
gs://my-bucket/my-image2.jpg
gs://my-bucket/my-image3.jpg
- INPUT_FILE_URI=Cloud Storage URI file input Anda> setiap baris dalam file input hanyalah URI Cloud Storage dari gambar yang akan diproses, misalnya, gs://my-bucket/my-image.jpg
- OUTPUT_URI_PREFIX=Awalan URI Cloud Storage untuk file hasil output, misalnya, gs://my-bucket/my-output-dir
curl -sS -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" https://visionai.googleapis.com/v1alpha1/projects/PROJECT_ID/locations/us-central1/retailEndpoints/ENDPOINT_ID:batchAnalyze -d '{
"gcsSource": {
"uris": ["INPUT_FILE_URI"]
},
"features": [
{
"type": "TYPE_PRODUCT_RECOGNITION",
}
],
"outputGcsDestination": {
"outputUriPrefix": "OUTPUT_URI_PREFIX"
}
}'
"features": [
{
"type": "TYPE_PRODUCT_RECOGNITION",
"productRecognitionConfig": {
"recognitionConfidenceThreshold": 0.4
}
}
],
Ada juga kolom lainnya yang dapat Anda tetapkan dan konfigurasi di
productRecognitionConfig, yang merupakan objek RetailProductRecognitionConfig.
Lihat deskripsi resource di referensi API untuk mengetahui detail selengkapnya.
Referensi API
Resource: projects.locations.retailCatalogs
Representasi JSON
{
"name": string,
"displayName": string,
"createTime": string,
"updateTime": string,
"resourceState": enum(RetailResourceState),
"labels": {
string: string,
...
}
}
Kolom
nama |
String |
Hanya output. Nama resource RetailCatalog |
|---|---|---|
displayName |
String |
Opsional. Nama tampilan RetailCatalog. |
createTime |
string (format Timestamp) |
Hanya output. Stempel waktu saat RetailCatalog ini dibuat. |
updateTime |
string (format Timestamp) |
Hanya output. Stempel waktu update. |
resourceState |
enum |
Hanya output. Status RetailCatalog. |
label |
map (key: string, value: string) |
Label dengan metadata yang ditentukan pengguna untuk mengatur RetailCatalog Anda. Kunci dan nilai label tidak boleh lebih dari 64 karakter (titik kode Unicode), hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Karakter internasional diperbolehkan. Lihat https://goo.gl/xmQnxf untuk mengetahui informasi dan contoh label selengkapnya. Objek yang berisi daftar pasangan "key": value pair. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
Metode: projects.locations.retailCatalogs.create
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/us-central1}/retailCatalogs
Parameter lokasi
| parent | string | Wajib. ID induk. |
Isi permintaan
Isi permintaan memuat instance RetailCatalog.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailCatalog yang baru dibuat.
Metode: projects.locations.retailCatalogs.get
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}
Parameter lokasi
| nama | string | Wajib. ID RetailCatalog. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailCatalog.
Metode: projects.locations.retailCatalogs.list
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/us-central1}/retailCatalogs
Parameter lokasi
| parent | string | Wajib. ID induk. |
Parameter kueri
| filter | string | Opsional. Ekspresi untuk memfilter hasil permintaan. |
|---|---|---|
| pageToken | string | Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. |
| pageSize | integer | Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. |
| orderBy | string | Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk menurun. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut: Representasi JSON
{
"retailCatalogs": [
{
object (RetailCatalog)
}
],
"nextPageToken": string
}
Metode: projects.locations.retailCatalogs.delete
Permintaan HTTP
DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}
Parameter lokasi
| nama | string | Wajib. ID RetailCatalog. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Metode: projects.locations.retailCatalogs.importRetailProducts
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}:importRetailProducts
Parameter lokasi
| nama | string | Wajib. Nama resource RetailCatalog. |
Isi permintaan
Representasi JSON
{
"gcsSource": { object(GcsSource) },
"format": enum(Format)
}
Kolom
| gcsSource | objek | Wajib. Lokasi Cloud Storage untuk konten input.
Beberapa lokasi input dapat diberikan. Konten semua lokasi input
akan diimpor dalam satu batch. Ekstensi file yang didukung: 1.
File JSONL. Setiap baris adalah format JSON RetailProductIoFormat. 2. File TXT. Setiap baris adalah GTIN Produk yang akan diimpor. |
| format | enum | Wajib. Format file impor. |
Memformat nilai ENUM
| FORMAT_UNSPECIFIED | Tidak boleh digunakan. |
|---|---|
| FORMAT_TXT | Format TXT. |
| FORMAT_JSONL | Format JSONL. |
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Resource: projects.locations.retailProducts
Representasi JSON
{
"name": string,
"gtins": [string],
"normalizedGtins": [string],
"thirdPartyIds": [ { object(ThirdPartyId) }],
"locale": string,
"brand": string,
"title": string,
"productUri": string,
"resourceState": enum(RetailResourceState),
"labels": {
string: string,
...
}
"createTime": string,
"updateTime": string
}
Kolom
nama |
String |
Hanya output. Nama resource RetailProductImage |
|---|---|---|
displayName |
String |
Opsional. Nama tampilan RetailProductImage. |
sourceType |
enum |
Opsional. Jenis sumber |
gcsUri |
string |
Opsional. Lokasi Cloud Storage RetailProductImage. Kolom ini harus ditetapkan kecuali jika gambar disediakan oleh Google, misalnya, jika jenis sumber adalah SOURCE_TYPE_GOOGLE. |
resourceState |
enum |
Hanya output. Status RetailProductImage. |
label |
map (key: string, value: string) |
Label dengan metadata yang ditentukan pengguna untuk mengatur RetailProductImage Anda. Kunci dan nilai label tidak boleh lebih dari 64 karakter (titik kode Unicode), hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Karakter internasional diperbolehkan. Lihat https://goo.gl/xmQnxf untuk mengetahui informasi dan contoh label selengkapnya. Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
createTime |
string (format Timestamp) |
Hanya output. Stempel Waktu pembuatan. |
updateTime |
string (format Timestamp) |
Hanya output. Stempel waktu update. |
RetailThirdPartyId Presentasi JSON
{
"id": string,
"owner": string
}
Kolom
| id | string | ID pihak ketiga yang digunakan oleh retailer atau produsen (misalnya, SKU atau MPN). |
| owner | string | Entitas yang 'memiliki' ID pihak ketiga, misalnya, produsen atau retailer yang menjual produk ini. |
Metode: projects.locations.retailCatalogs.retailProducts.create
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProducts
Parameter lokasi
| parent | string | Wajib. ID induk. |
Isi permintaan
Isi permintaan memuat instance RetailProduct.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailProduct yang baru dibuat.
Metode: projects.locations.retailCatalogs.retailProducts.get
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*
Parameter lokasi
| nama | string | Wajib. ID RetailProduct. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailProduct.
Metode: projects.locations.retailCatalogs.retailProducts.list
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProducts
Parameter lokasi
| parent | string | Wajib. ID induk. |
Parameter kueri
| filter | string | Opsional. Ekspresi untuk memfilter hasil permintaan. |
|---|---|---|
| pageToken | string | Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. |
| pageSize | integer | Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. |
| orderBy | string | Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk menurun. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut: Representasi JSON
{
"retailProducts": [
{
object (RetailProducts)
}
],
"nextPageToken": string
}
Metode: projects.locations.retailCatalogs.retailProducts.delete
Permintaan HTTP
DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*
Parameter lokasi
| nama | string | Wajib. ID RetailProduct. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan kosong.
Resource: projects.locations.retailProductImages
Representasi JSON
{
"name": string,
"displayName": string,
"sourceType": enum(SourceType),
"gcsUri": string,
"resourceState": enum(RetailResourceState),
"labels": {
string: string,
...
}
"createTime": string,
"updateTime": string
}
Kolom
nama |
String |
Hanya output. Nama resource RetailProductImage |
|---|---|---|
displayName |
String |
Opsional. Nama tampilan RetailProductImage. |
sourceType |
enum |
Opsional. Jenis sumber |
gcsUri |
string |
Opsional. Lokasi Cloud Storage RetailProductImage. Kolom ini harus ditetapkan kecuali jika gambar disediakan oleh Google, misalnya, jika jenis sumber adalah SOURCE_TYPE_GOOGLE. |
resourceState |
enum |
Hanya output. Status RetailProductImage. |
label |
map (key: string, value: string) |
Label dengan metadata yang ditentukan pengguna untuk mengatur RetailProductImage Anda. Kunci dan nilai label tidak boleh lebih dari 64 karakter (titik kode Unicode), hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Karakter internasional diperbolehkan. Lihat https://goo.gl/xmQnxf untuk mengetahui informasi dan contoh label selengkapnya. Objek yang berisi daftar pasangan "key": value pair. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
createTime |
string (format Timestamp) |
Hanya output. Stempel Waktu pembuatan. |
updateTime |
string (format Timestamp) |
Hanya output. Stempel waktu update. |
Nilai ENUM SourceType
| SOURCE_TYPE_UNSPECIFIED | Sumber data tidak diketahui. Tidak boleh digunakan. |
|---|---|
| SOURCE_TYPE_FIXED_CAMERA | Gambar diambil dari kamera tetap. |
| SOURCE_TYPE_HAND_HELD_CAMERA | Gambar diambil dari kamera genggam. |
| SOURCE_TYPE_CRAWLED | Gambar di-crawl dari web. |
| SOURCE_TYPE_SYSTEM_GENERATED | Gambar dipangkas dari gambar asli dengan pelabelan manusia. |
Metode: projects.locations.retailCatalogs.retailProducts.retailProductImages.create
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*/retailProducts/*}/retailProductImages
Parameter lokasi
| parent | string | Wajib. ID induk. |
Isi permintaan
Isi permintaan memuat instance RetailProductImage.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailProductImage yang baru dibuat.
Metode: projects.locations.retailCatalogs.retailProducts.retailProductImages.get
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*/retailProductImages/*
Parameter lokasi
| nama | string | Wajib. ID RetailProductImage. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailProductImage.
Metode: projects.locations.retailCatalogs.retailProducts.retailProductImages.list
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*/retailProducts/*}/retailProductImages
Parameter lokasi
| parent | string | Wajib. ID induk. |
Parameter kueri
| filter | string | Opsional. Ekspresi untuk memfilter hasil permintaan. |
|---|---|---|
| pageToken | string | Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. |
| pageSize | integer | Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. |
| orderBy | string | Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk menurun. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON
{
"retailProductImages": [
{
object (RetailProductImages)
}
],
"nextPageToken": string
}
Metode: projects.locations.retailCatalogs.retailProducts.retailProductImages.delete
Permintaan HTTP
DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*/retailProductImages/*
Parameter lokasi
| nama | string | Wajib. ID RetailProductImage. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan kosong.
Resource: projects.locations.retailCatalogs.retailProductSets
Representasi JSON
{
"name": string,
"displayName": string,
"retailProductIds": [string],
"resourceState": enum(RetailResourceState),
"labels": {
string: string,
...
}
"createTime": string,
"updateTime": string
}
Kolom
nama |
String |
Hanya output. Nama resource RetailProductSet |
|---|---|---|
displayName |
String |
Opsional. Nama tampilan RetailProductSet. |
retailProductIds [] |
String |
Hanya output. ID resource produk yang termasuk dalam RetailProductSet ini. Produk dalam RetailProductSet harus berada dalam katalog yang sama. |
resourceState |
enum |
Hanya output. Status RetailProductSet. |
label |
map (key: string, value: string) |
Label dengan metadata yang ditentukan pengguna untuk mengatur RetailProductSet Anda. Kunci dan nilai label tidak boleh lebih dari 64 karakter (titik kode Unicode), hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Karakter internasional diperbolehkan. Lihat https://goo.gl/xmQnxf untuk mengetahui informasi dan contoh label selengkapnya. Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
createTime |
string (format Timestamp) |
Hanya output. Stempel Waktu pembuatan. |
updateTime |
string (format Timestamp) |
Hanya output. Stempel waktu update. |
Metode: projects.locations.retailCatalogs.retailProductSets.create
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductSets
Parameter lokasi
| parent | string | Wajib. ID induk. |
Isi permintaan
Isi permintaan berisi instance RetailProductSet.
Isi respons
Jika berhasil, isi respons berisi instance RetailProductSet yang baru dibuat.
Metode: projects.locations.retailCatalogs.retailProductSets.get
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*
Parameter lokasi
| nama | string | Wajib. ID RetailProductSet. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons berisi instance RetailProductSet.
Metode: projects.locations.retailCatalogs.retailProductSets.list
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductSets
Parameter lokasi
| parent | string | Wajib. ID induk. |
Parameter kueri
| filter | string | Opsional. Ekspresi untuk memfilter hasil permintaan. |
|---|---|---|
| pageToken | string | Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. |
| pageSize | integer | Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. |
| orderBy | string | Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk menurun. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON
{
"retailProductSets": [
{
object (RetailProductSets)
}
],
"nextPageToken": string
}
Metode: projects.locations.retailCatalogs.retailProductSets.delete
Permintaan HTTP
DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*
Parameter lokasi
| nama | string | Wajib. ID RetailProductSet. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan kosong.
Metode: projects.locations.retailCatalogs.retailProductSets.add
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*}:remove
Parameter lokasi
| nama | string | Wajib. Nama resource RetailProductSet. |
Isi permintaan
Representasi JSON
{
"productIds": [string],
"productFilter": string
}
Kolom
productIds[ ] |
string |
ID resource RetailProduct yang akan ditambahkan. Semua produk tersebut harus termasuk dalam RetailCatalog yang sama dengan RetailProductSet tujuan yang ditentukan. Hingga 200 ID RetailProduct dapat ditentukan dalam satu permintaan. Tidak dapat digunakan bersama dengan productFilter. |
|---|---|---|
productFilter |
string |
Filter standar yang akan diterapkan ke semua RetailProduct di RetailCatalog induk, memilih item yang memenuhi kondisi filter dan menambahkannya ke RetailProductSet. Tidak dapat digunakan bersama dengan product_ids. Filter yang didukung: https://google.aip.dev/160 |
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Metode: projects.locations.retailCatalogs.retailProductSets.remove
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*}:add
Parameter lokasi
| nama | string | Wajib. Nama resource RetailProductSet. |
Isi permintaan
Representasi JSON
{
"productIds": [string],
"productFilter": string
}
Kolom
productIds[ ] |
string |
ID resource RetailProduct yang akan dihapus. Jika RetailProducts yang ditentukan bukan milik RetailProductSet ini, RetailProducts tersebut akan diabaikan. Hingga 200 ID RetailProduct dapat ditentukan dalam satu permintaan. Tidak dapat digunakan bersama dengan products_filter. |
|---|---|---|
productFilter |
string |
Filter standar yang akan diterapkan ke semua RetailProduct dalam RetailProductSet yang ditentukan, pilih item yang memenuhi kondisi filter, lalu hapus item tersebut dari RetailProductSet. Tidak dapat digunakan bersama dengan product_ids. Filter yang didukung:https://google.aip.dev/160 |
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Resource: projects.locations.retailCatalogs.retailProductRecognitionIndexes
Representasi JSON
{
"name": string,
"displayName": string,
"description": string,
"retailProductSet": [string],
"resourceState": enum(RetailResourceState),
"labels": {
string: string,
...
}
"createTime": string,
"updateTime": string
}
Kolom
nama |
String |
Hanya output. Nama resource RetailProductRecognitionIndex. |
|---|---|---|
displayName |
String |
Opsional. Nama tampilan RetailProductRecognitionIndex. |
deskripsi |
String |
Opsional. Deskripsi RetailProductRecognitionIndex. |
retailProductSet[] |
string |
Opsional. Nama resource RetailProductSet yang akan digunakan untuk membuat resource ini. Jika disetel, RetailProductRecognitionIndex hanya akan berisi produk dalam RetailProductSet tertentu. Jika tidak disetel, semua produk dalam katalog induk akan digunakan. |
resourceState |
enum |
Hanya output. Status RetailProductRecognitionIndex. |
label |
map (key: string, value: string) |
Label dengan metadata yang ditentukan pengguna untuk mengatur RetailProductRecognitionIndex Anda. Kunci dan nilai label tidak boleh lebih dari 64 karakter (titik kode Unicode), hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Karakter internasional diperbolehkan. Lihat https://goo.gl/xmQnxf untuk mengetahui informasi dan contoh label selengkapnya. Objek yang berisi daftar pasangan "key": value pair. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
createTime |
string (format Timestamp) |
Hanya output. Stempel Waktu pembuatan. |
updateTime |
string (format Timestamp) |
Hanya output. Stempel waktu update. |
Metode: projects.locations.retailCatalogs.retailProductRecognitionIndexes.create
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductRecognitionIndexes
Parameter lokasi
| parent | string | Wajib. ID induk. |
Isi permintaan
Isi permintaan memuat instance RetailProductRecognitionIndex.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailProductRecognitionIndex yang baru dibuat.
Metode: projects.locations.retailCatalogs.retailProductRecognitionIndexes.get
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*
Parameter lokasi
| nama | string | Wajib. ID RetailProductRecognitionIndex. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan berisi instance
RetailProductRecognitionIndex.
Metode: projects.locations.retailCatalogs.retailProductRecognitionIndexes.list
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductRecognitionIndexes
Parameter lokasi
| parent | string | Wajib. ID induk. |
Parameter kueri
| filter | string | Opsional. Ekspresi untuk memfilter hasil permintaan. |
|---|---|---|
| pageToken | string | Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. |
| pageSize | integer | Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. |
| orderBy | string | Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk menurun. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON
{
"retailProductRecognitionIndexes": [
{
object (RetailProductRecognitionIndex)
}
],
"nextPageToken": string
}
Metode: projects.locations.retailCatalogs.retailProductRecognitionIndexes.delete
Permintaan HTTP
DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*
Parameter lokasi
| nama | string | Wajib. ID ProductRecognitionIndex. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Resource: projects.locations.retailEndpoints
Representasi JSON
{
"name": string,
"displayName": string,
"description": string,
"deployedProductRecognitionIndex": string,
"resourceState": enum(RetailResourceState),
"productRecognitionConfig": { object(RetailProductRecognitionConfig) },
"tagRecognitionConfig": { object(RetailTagRecognitionConfig) },
"labels": {
string: string,
...
}
"createTime": string,
"updateTime": string
}
Kolom
nama |
String |
Hanya output. Nama resource RetailEndpoint. |
|---|---|---|
displayName |
String |
Opsional. Nama tampilan RetailEndpoint. |
deskripsi |
String |
Opsional. Deskripsi RetailEndpoint. |
deployedProductRecognitionIndex |
String |
Hanya output. Nama resource ProductRecognitionIndex yang di-deploy ke RetailEndpoint ini. |
productRecognitionConfig |
Objek
|
Opsional. Konfigurasi untuk pengenalan produk. |
tagRecognitionConfig |
Objek
|
Opsional. Konfigurasi untuk pengenalan tag. |
resourceState |
enum |
Hanya output. Status RetailProductRecognitionIndex. |
label |
map (key: string, value: string) |
Label dengan metadata yang ditentukan pengguna untuk mengatur RetailProductRecognitionIndex Anda. Kunci dan nilai label tidak boleh lebih dari 64 karakter (titik kode Unicode), hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Karakter internasional diperbolehkan. Lihat https://goo.gl/xmQnxf untuk mengetahui informasi dan contoh label selengkapnya. Objek yang berisi daftar pasangan "key": value pair. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }. |
createTime |
string (format Timestamp) |
Hanya output. Stempel Waktu pembuatan. |
updateTime |
string (format Timestamp) |
Hanya output. Stempel waktu update. |
RetailProductRecognitionConfig
Representasi JSON
{
"productDetectionModel": string,
"detectionConfidenceThreshold": float,
"recognitionConfidenceThreshold": float,
"additionalConfig": { object }
}
Kolom
|
| productDetectionModel | string | Wajib. Model yang akan digunakan untuk mendeteksi produk dalam gambar input. Nilai yang didukung: "builtin/stable" (default) atau nama resource model Vertex AI. |
|---|---|---|
| detectionConfidenceThreshold | float | Opsional. Nilai minimum keyakinan untuk memfilter hasil deteksi. Jika tidak disetel, nilai default sistem akan digunakan. |
| recognitionConfidenceThreshold | float | Opsional. Ambang batas keyakinan untuk memfilter hasil pengenalan. Jika tidak disetel, nilai default sistem akan digunakan. |
| additionalConfig | object (format Struct) | Opsional. Konfigurasi tambahan untuk pengenalan produk. |
RetailTagRecognitionConfig
Representasi JSON
{
"tagDetectionModel": string,
"tagParsingModel": string,
"detectionConfidenceThreshold": float,
"parsingConfidenceThreshold": float,
"additionalConfig": { object }
}
Kolom
| tagDetectionModel | string | Wajib. Model yang akan digunakan untuk mendeteksi tag dalam gambar input. Nilai yang didukung: Resource model Vertex AI. |
|---|---|---|
| tagParsingModel | string | Wajib. Model untuk mengurai teks pada tag yang terdeteksi. Nilai yang didukung: Resource model Vertex AI. |
| detectionConfidenceThreshold | float | Opsional. Nilai minimum keyakinan untuk memfilter hasil deteksi. Jika tidak disetel, nilai default sistem akan digunakan. |
| parsingConfidenceThreshold | float | Opsional. Ambang batas keyakinan untuk memfilter hasil parsing teks. Jika tidak disetel, nilai default sistem akan digunakan. |
| additionalConfig | object (format Struct) | Opsional. Konfigurasi tambahan untuk pengenalan tag. |
Metode: projects.locations.retailEndpoints.create
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/retailEndpoints
Parameter lokasi
| parent | string | Wajib. ID induk. |
Isi permintaan
Isi permintaan memuat instance RetailEndpoint.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailEndpoint yang baru dibuat.
Metode: projects.locations.retailEndpoints.get
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailEndpoints/*}
Parameter lokasi
| nama | string | Wajib. ID RetailEndpoint. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance RetailEndpoint.
Metode: projects.locations.retailEndpoints.list
Permintaan HTTP
GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/retailEndpoints
Parameter lokasi
| parent | string | Wajib. ID induk. |
Parameter kueri
| filter | string | Opsional. Ekspresi untuk memfilter hasil permintaan. |
|---|---|---|
| pageToken | string | Opsional. Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. |
| pageSize | integer | Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. |
| orderBy | string | Opsional. Daftar kolom yang dipisahkan koma untuk diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk menurun. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON
{
"retailEndpoints": [
{
object (RetailEndpoint)
}
],
"nextPageToken": string
}
Metode: projects.locations.retailEndpoints.delete
Permintaan HTTP
DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailEndpoints/*
Parameter lokasi
| nama | string | Wajib. ID RetailEndpoint. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan kosong.
Metode: projects.locations.retailEndpoints.deployRetailProductRecognitionIndex
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:deployRetailProductRecognitionIndex
Parameter lokasi
| retailEndpoint | string | Wajib. Nama resource RetailEndpoint
resource tempat
RetailProductRecognitionIndex di-deploy. |
Isi permintaan
Representasi JSON
{
"retailProductRecognitionIndex": string,
}
Kolom
| retailProductRecognitionIndex | string | Wajib. Nama resource
RetailProductRecognitionIndex
yang akan di-deploy. |
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Metode: projects.locations.retailEndpoints.undeployRetailProductRecognitionIndex
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:undeployRetailProductRecognitionIndex
Parameter lokasi
| retailEndpoint | string | Wajib. Nama resource RetailEndpoint
resource yang akan dibatalkan deployment-nya. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Metode: projects.locations.retailEndpoints.batchAnalyze
Permintaan HTTP
POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:batchAnalyze
Parameter lokasi
| retailEndpoint | string | Wajib. Nama resource RetailEndpoint
untuk menayangkan permintaan inferensi. |
Isi permintaan
Representasi JSON
{
"gcsSource": string,
"features": { object(Feature) },
// Union field output can be only one of the following:
"outputGcsDestination": string,
"corpus": string,
// End of list of possible types for union field output.
"bigqueryTable": string
}
Kolom
| gcsSource | string | Wajib. Lokasi Cloud Storage untuk konten input. Beberapa lokasi input dapat diberikan. Isi semua lokasi input akan diproses dalam satu batch. Konten yang didukung: File TXT, setiap baris adalah jalur lengkap ke gambar. Maksimum 50 ribu gambar dapat didukung dalam satu permintaan. |
|---|---|---|
| outputGcsDestination | string | Opsional. Lokasi Cloud Storage dari direktori tempat output akan ditulis. |
| corpus | string | Opsional. Nama resource korpus gudang gambar. Belum didukung. |
| bigqueryTable | string | Opsional. Nama resource tabel BigQuery untuk ekspor anotasi. Dalam format "projects/*/datasets/*/tables/*". Jika disetel, anotasi yang dihasilkan dari inferensi ML juga akan diekspor ke tabel BigQuery yang ditentukan. Belum didukung. |
| features[] | Objek | Wajib. Jenis inferensi ML yang akan dilakukan. |
Fitur
Representasi JSON
{
"type": enum(Type),
"productRecognitionConfig": object(RetailProductRecognitionConfig),
"tagRecognitionConfig": object(RetailTagRecognitionConfig)
}
Kolom
| jenis | enum | Wajib. Jenis Fitur. |
|---|---|---|
| productRecognitionConfig | objek | Opsional. Penggantian per permintaan untuk fitur pengenalan produk. Nilai ini hanya efektif jika jenis ditetapkan ke TYPE_PRODUCT_RECOGNITION. |
| tagRecognitionConfig | objek | Opsional. Penggantian per permintaan untuk fitur pengenalan tag. Hanya berlaku jika jenis ditetapkan ke TYPE_TAG_RECOGNITION. |
Isi respons
Jika berhasil, isi respons akan memuat instance Operation.
Jenis
GcsSource
Representasi JSON
{
"uris": [string]
}
Kolom
| uris[] | string | Wajib. Referensi ke jalur Cloud Storage. |
Jenis
Nilai ENUM
| TYPE_UNSPECIFIED | Nilai default. Tidak boleh digunakan. |
|---|---|
| TYPE_PRODUCT_RECOGNITION | Pengenalan Produk. Harus digunakan di
RetailEndpoint dengan
RetailProductRecognitionIndex yang di-deploy. |
| TYPE_TAG_RECOGNITION | Deteksi dan Penguraian Tag. Harus digunakan pada
RetailEndpoint dengan
RetailTagRecognitionConfig. |
RetailProductIoFormat
Representasi JSON
{
"retailProduct": { object(RetailProduct) },
"retailProductImages": [ { object(RetailProductImage) }]
}
Kolom
| retailProduct | objek | Wajib. RetailProduct yang akan diimpor |
|---|---|---|
| retailProductImages[ ] | objek | Opsional. RetailProductImages dari
RetailProduct yang diberikan untuk diimpor. |
RetailResourceState
Nilai ENUM
| RETAIL_RESOURCE_STATE_UNSPECIFIED | Nilai default. Tidak boleh digunakan. |
|---|---|
| RETAIL_RESOURCE_STATE_CREATING | Membuat Status. |
| RETAIL_RESOURCE_STATE_CREATED | Status Dibuat. |
| RETAIL_RESOURCE_STATE_UPDATING | Memperbarui Status. |
| RETAIL_RESOURCE_STATE_DELETED | Status Dihapus. |
| RETAIL_RESOURCE_STATE_ERROR | Error Negara Bagian. |