מדריך לזיהוי תגים

מודל Tag Recognizer עוזר לכם לפתור בעיות מרכזיות בהבנת המדף הקמעונאי, כלומר לזהות ולנתח את התגים (לדוגמה, תג המחיר או תגי תוויות אחרים) בהתאם לסכימת חילוץ של ישויות מסוג צמד מפתח/ערך שהוגדרה על ידי המשתמש.

המודל הזה יכול לשמש כרכיב AI בסיסי לניתוח ולפרשנות של נתוני תמונות מוצרים בחנויות קמעונאיות. לדוגמה, אפשר להשתמש במודל הזה בתמונות של מדפים שצולמו על ידי מצלמות מקומיות או מכשירים ניידים.

תרחישים לדוגמה לשימוש בכלי לזיהוי תגים ובכלי לזיהוי מוצרים

המודלים Product Recognizer ו-Tag Recognizer יכולים לשמש כאבני הבניין העיקריות של AI לניתוח ולפרשנות של נתוני תמונות שקשורים למוצרים ולתגיות, שאולי צילמתם בחנויות קמעונאיות.

המודלים של כלי זיהוי המוצרים וכלי זיהוי התגים משלבים כמה יכולות ליבה של Google בתחום ה-AI, כולל יכולות של בניית מודלים וניתוח נתונים. המודלים האלה עוזרים לקמעונאים ו/או לשותפים טכניים לפתור בעיות מרכזיות בהבנת נתוני התמונות של המוצרים ותגי המחיר, כולל:

  • זיהוי, כלומר הבנה איזה מוצר מופיע בתמונה.
  • זיהוי וניתוח של התג (לדוגמה, price-tag או כל תג אחר של תווית טקסט) בהתאם לסכימת חילוץ של ישות מסוג צמד מפתח/ערך שהוגדרה על ידי המשתמש.

בפרט, נכללים כמה מודלים של AI מבית Google שמאפשרים לפתור בעיות בתרחישי השימוש האלה, כמו

  • מודל להטמעה חזותית של תמונות ממוזערות של מוצרים, שממיר תמונה ממוזערת של מוצר לייצוג של מרחב תכונות מספרי.
  • מודל OCR של Google, ששולף את כל הטקסט שמופיע בתמונה.
  • מודל לחילוץ ישויות של Google (שאפשר להתאים אישית), שהופך את הטקסטים הגולמיים לישויות בעלות שם שהן צמדים של מפתח/ערך שהוגדרו על ידי המשתמש.

בנוסף למודלים של AI מבית Google, מזהה המוצרים מסתמך גם על מסד הנתונים הגדול של Google עם פרטי מוצרים. נתוני המוצרים במסד הנתונים הזה כוללים את מזהה ה-GTIN או קוד מוצר אוניברסלי (UPC) של המוצר, המותג, השם והתיאורים בשפות שונות, הלוגו ותמונות עם וריאציות שונות של האריזה. מסד הנתונים של המוצרים, עם מודל ההטמעה החזותית של התמונות הממוזערות של המוצרים שצוין קודם, מאפשר למודל לזיהוי מוצרים לזהות מוצרים רבים באופן מיידי.

שתי התכונות העיקריות של ה-AI הן מודלים של זיהוי מוצרים וזיהוי תגים.

הפונקציונליות של הכלי לזיהוי תגים

המודל מזהה את כל מחרוזות הטקסט בתג, ואז מנסה לנתח את הטקסט לפי סכמת חילוץ ישויות של זוגות מפתח/ערך שהוגדרה על ידי המשתמש, כמו תיאור פריט מוצר או ערך מחיר. הוא כולל את מודלי ה-AI הבאים של Google:

  • טכנולוגיית ה-OCR של Google, ששולפת את כל הטקסט שגלוי בתמונה.
  • מודל חילוץ הישויות של Google, שהופך את הטקסט הגולמי לישויות בעלות שם של צמד מפתח/ערך שהוגדרו על ידי המשתמש. התאמה אישית של המודל באמצעות Vertex AI. לדוגמה, אם חשוב לכם בעיקר תיאור פריט המוצר, ערך מחיר המוצר או מחיר המבצע, אבל לא שום דבר אחר, המשתמש יכול להגדיר את סכמת ניתוח התגים באופן הבא:

    key: item_description   value: string
    key: regular_price      value: number
    key: sale_price         value: number
    

סכימת ניתוח תגים

אחרי אימון מותאם אישית של מודל לחילוץ ישויות, המערכת תזהה ותנתח את תיבת הפריט של התג בהתאם לסכימה שהוגדרה על ידי המשתמש. לדוגמה:

  item_description:   COLLECTION 18PC GFT BX
  regular_price:      1099
  sale_price:         999

דוגמה לאובייקט JSON של פלט

{
  "imageUri": "gs://test_bucket/test_image.jpg",
  "tagRecognitionAnnotations": [
    {
      "entities": [
        {
          "confidence": 0.99646133,
          "mentionText": "NISSIN TOP RAMEN\n\nBOW CHICKEN\n\n",
          "region": {
            "xMax": 0.4618055,
            "xMin": 0.042725038,
            "yMax": 0.45387268,
            "yMin": 0.18415153
          },
          "type":"description"
        },
        {
          "confidence": 0.95828205,
          "mentionText": "$3.90\n",
          "region": {
            "xMax": 0.24819264,
            "xMin": 0.04185935,
            "yMax": 0.96134734,
            "yMin": 0.80382305
          },
          "type":"unit_price"
        },
        {
          "confidence": 0.60659707,
          "mentionText": "$14.99\n",
          "region": {
            "xMax": 0.9754113,
            "xMin": 0.3654699,
            "yMax": 0.92825794,
            "yMin": 0.40368474
          },
          "type":"price"
        }
      ]
    }
  ]
}

הגדרת הסביבה

בקטע הזה מוסבר איך ליצור אינטראקציה עם Store Vision AI RESTful API.

API_ENDPOINT=visionai.googleapis.com
PROJECT_ID=your project ID

בכל השיטות של create צריך לציין במפורש את השם או המזהה של המשאב שרוצים ליצור. אפשר להשתמש במזהה שהוא מחרוזת בעלת משמעות, למשל product-ABC, או במזהה שנוצר באופן אקראי, למשל UUID.

כדי להעניק לאדם מסוים הרשאת עריכה לשימוש ב-Store Vision API, מריצים את פקודת ה-IAM הבאה:

gcloud projects add-iam-policy-binding PROJECT_ID --member='user:USER_ACCOUNT' --role='roles/visionai.editor'

כדי להעניק לחשבון שירות גישת עריכה, משתמשים בפקודה הבאה:

gcloud projects add-iam-policy-binding PROJECT_ID --member='serviceAccount:SERVICE_ACCOUNT' --role='roles/visionai.editor'

מידע נוסף על קישור ב-IAM

תהליך השימוש בכלי לזיהוי תגים

  1. אפשר לבצע אימון מותאם אישית של מודל לזיהוי תגים באמצעות התכונה Vertex AI / AutoML Vision Object Detection.
  2. אימון מודל לניתוח ישויות של תגים באמצעות התכונה Vertex AI / AutoML Vision Object Detection עם מנוע OCR מותאם אישית.
  3. יוצרים נקודת קצה עם הגדרת זיהוי התגים הרצויה.
  4. מבצעים BatchAnalyze באמצעות התכונה TagRecognition. בצד השרת, המערכת תזהה תגים מכל תמונת קלט, תנתח את הטקסט בכל תג שזוהה ותפיק פלט מנותח ומובנה. T ## אימון מודל לזיהוי תגים וניתוח ישויות

אתם יכולים לאמן את המודל המותאם אישית לזיהוי תגים באמצעות התכונה לאימון מודלים לזיהוי אובייקטים בתמונות של המוצר הקיים שלנו Vertex AI / AutoML Vision. למרות שתכונת האימון של מודל זיהוי האובייקטים ב-Vertex AI / AutoML Vision מספקת חוויית אימון מודל מנוהלת באופן מלא, עדיין באחריותכם להכין מערך נתונים של תמונות עם דגימה טובה, עם הערות של תיבות תוחמות של אובייקטים שסומנו באופן מלא, כמערך הנתונים לאימון שיוזן למסוף אימון המודל. Google Cloud מספקת את שירות יצירת תוויות לנתונים של Vertex AI כדי לאפשר לכם ליצור את משימת תיוג הנתונים. לפרטים נוספים, אפשר לעיין בקישור הבא בנושא משימות של תוויות לנתונים ב-Vertex AI: /vertex-ai/docs/datasets/data-labeling-job. חשוב לספק למעריכים האנושיים הוראות ברורות לתוויות נתונים, כדי שהם ידעו איך לתייג את תיבות התוחמות של זיהוי התגים בתמונות כהכנה של מערך נתוני האימון.

כדי לאמן את מודל ניתוח ישויות התגים, צריך להכין אוסף של נתוני אימון, עם תמונות וההערות המשויכות שלהן.

  • התמונה היא תמונה של תג שכבר נחתכה.
  • בכל תמונה צריך להגדיר ולספק את שדה הישות הראשי (למשל, השדות product_title, ‏ price, ‏ unit_price) שרוצים לזהות ולנתח, ואת מיקום הקואורדינטות של תיבת התוחמת המשויכת בתצוגת התמונה החתוכה.
  • כדי לתמוך בזיהוי או בניתוח הנכונים, אנחנו גם דורשים שתספקו את תחביר הביטוי הרגולרי כדי לאפיין כל שדה. הפרמטר הזה נדרש כדי לעזור לאלגוריתם לניתוח התגים בתהליך האימון ובשגרת ההסקה.

תמונה עם תג מוכר

דוגמה לאימון של ניתוח ישויות בתגים

לדוגמה, אם ניקח את הדוגמה הקודמת של אימון ניתוח ישויות של תגים, תוכלו לספק שורה אחת של פרטי הערה בקובץ ה-CSV של הערות לנתוני האימון באופן הבא:

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

בדוגמה הקודמת:

  • לשדה product_title יש קואורדינטות של תיבת התמונה התואמת (x0, y0, x1, y1), והאילוץ של הביטוי הרגולרי בשדה הזה הוא none.
  • השדה 'מחיר' כולל את הקואורדינטות המתאימות של תיבת התמונה '(x0, y0, x1, y1)', והאילוץ של הביטוי הרגולרי בשדה הזה הוא '‎\$\d+\.\d{2}‎'. הביטוי הזה מציין שאנחנו מחפשים לזהות ולנתח את השדה הזה עם סימן הדולר בתחילת הזנת הטקסט, כמה ספרות לפני הנקודה ושתי ספרות אחרי הנקודה.
  • השדה unit_price (מחיר ליחידה) כולל את אותה תחביר של הערות כמו השדה price (מחיר). לדוגמה, הקואורדינטות של תיבת התמונה הן (x0, y0, x1, y1), והאילוץ של הביטוי הרגולרי בשדה הזה הוא ‎\$\d+\.\d{2}‎. המשמעות היא שאנחנו מחפשים לזהות ולנתח את השדה הזה עם הסימן $ בתחילת הזנת הטקסט, כמה ספרות לפני הנקודה ושתי ספרות אחרי הנקודה.

לכן, נתוני אימון של מודל לניתוח תגי מחיר או לזיהוי ישויות יכללו אוסף של תמונות של תגי מחיר, עם ההערה בקובץ CSV, כאשר כל רשומה בשורת ה-CSV תהיה בדיוק כמו הרשומה בדוגמה הקודמת.

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

"image_filepath", "product_title", "(x0, y0, x1, y1)", "", "price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}", "unit_price", "(x0, y0, x1, y1)", "\\$\\d+\\.\\d{2}"

[...]

אתם יכולים לאמן את המודל המותאם אישית של ניתוח ישויות תיוג באמצעות התכונה לאימון מודלים של זיהוי אובייקטים בתמונות במוצר הקיים Vertex AI /AutoML Vision, וגם באמצעות ההתאמה האישית של מנוע ה-OCR של Google.

חשוב לציין: נכון ליולי 2022, עדיין אין תמיכה מלאה בהדרכה ובהטמעה של מודל מותאם אישית לזיהוי תגים ולניתוח ישויות תגים ב-BatchAnalyze API של Store Vision AI כחלק מחוויית שימוש משולבת במסוף. עם זאת, עדיין אפשר להשתמש בהדרכה של מודל מותאם אישית לזיהוי תגים ולניתוח ישויות תגים (באמצעות התכונה Object Detection של Vertex AI Vision) ולהפעיל אותם ב-BatchAnalyze API של Store Vision AI. לשם כך צריך לבצע כמה שלבים ידניים בשירות עצמי.

שימוש ב-API – ניתוח מסקנות של פעולות מקובצות

יצירת נקודת קצה
  • ENDPOINT_ID=מזהה נקודת הקצה
  • TAG_DETECTOR=שם מודל זיהוי התגים
  • TAG_PARSER=שם מודל ניתוח התגים
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 '{
  "tagRecognitionConfig": {
    "tag_detection_model": "TAG_DETECTOR_NAME",
    "tag_parsing_model": "TAG_PARSER_NAME"
  }
}'
  • INPUT_FILE_URI=Cloud Storage uri של קובץ הקלט, כל שורה בקובץ הקלט היא רק Cloud Storage uri של תמונה לעיבוד, לדוגמה, gs://my-bucket/my-image.jpg
  • OUTPUT_URI_PREFIX=קידומת URI של Cloud Storage לקובץ תוצאות הפלט, לדוגמה, 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_TAG_RECOGNITION",
     }
  ],
  "outputGcsDestination": {
    "outputUriPrefix": "OUTPUT_URI_PREFIX"
  }
}'
"features": [
    {
      "type": "TYPE_TAG_RECOGNITION",
      "tagRecognitionConfig": {
        "tag_detection_model": "'TAG_DETECTOR_NAME'",
        "tag_parsing_model": "TAG_PARSER_NAME"
      }
    }
  ],

יש גם שדות נוספים שאפשר להגדיר ולקבוע ב-tagRecognitionConfig, שהוא אובייקט RetailTagRecognitionConfig. פרטים נוספים מופיעים בתיאור המשאב בהפניית ה-API.

הפניית API

משאב: projects.locations.retailCatalogs

ייצוג ב-JSON

{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "resourceState": enum(RetailResourceState),
  "labels": {
    string: string,
    ...
  }
}

שדות


name

מחרוזת

פלט בלבד. שם המשאב של RetailCatalog

displayName

מחרוזת

אופציונלי. השם המוצג של RetailCatalog.

createTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן שבה נוצר קובץ RetailCatalog.

updateTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של העדכון.

resourceState

enum

פלט בלבד. הסטטוס של RetailCatalog.

labels

map (key: string, value: string)

התוויות עם המטא-נתונים שהוגדרו על ידי המשתמש לארגון של RetailCatalog.

המפתחות והערכים של התוויות יכולים להכיל עד 64 תווים (נקודות קוד של Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. אפשר להשתמש בתווים בינלאומיים.

מידע נוסף על תוויות ודוגמאות לתוויות זמינים בכתובת https://goo.gl/xmQnxf.

אובייקט שמכיל רשימה של צמדי מפתח: ערך. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Method: projects.locations.retailCatalogs.create

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/us-central1}/retailCatalogs

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

גוף הבקשה

גוף הבקשה מכיל מופע של RetailCatalog.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של RetailCatalog.

Method: projects.locations.retailCatalogs.get

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}

פרמטרים של נתיב

name מחרוזת חובה. RetailCatalog מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RetailCatalog.

‫Method: projects.locations.retailCatalogs.list

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/us-central1}/retailCatalogs

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

פרמטרים של שאילתה

מסנ מחרוזת זה שינוי אופציונלי. ביטוי לסינון התוצאות של הבקשה.
pageToken מחרוזת זה שינוי אופציונלי. אסימון שמזהה איזה דף תוצאות השרת צריך להחזיר.
pageSize מספר שלם זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מצוין ערך, השרת יבחר ברירת מחדל מתאימה.
orderBy מחרוזת זה שינוי אופציונלי. רשימה מופרדת בפסיקים של שדות שלפיהם ימוינו התוצאות בסדר עולה. אחרי שם השדה, משתמשים ב-desc כדי למיין בסדר יורד.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא: ייצוג JSON

{
  "retailCatalogs": [
    {
      object (RetailCatalog)
    }
  ],
  "nextPageToken": string
}

‫Method: projects.locations.retailCatalogs.delete

בקשת HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}

פרמטרים של נתיב

name מחרוזת חובה. RetailCatalog מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

‫Method: projects.locations.retailCatalogs.importRetailProducts

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/us-central1/retailCatalogs/*}:importRetailProducts

פרמטרים של נתיב

name מחרוזת חובה. RetailCatalog שם המשאב.

גוף הבקשה

ייצוג ב-JSON

{
  "gcsSource": { object(GcsSource) },
  "format": enum(Format)
}

שדות

gcsSource אובייקט חובה. המיקום ב-Cloud Storage של תוכן הקלט. אפשר לספק כמה מיקומי קלט. התוכן של כל מיקומי הקלט ייובא באצווה אחת. סיומות קובץ נתמכות: 1. קובץ JSONL. כל שורה היא בפורמט JSON של RetailProductIoFormat.
‫2. קובץ TXT. כל שורה היא מספר GTIN של מוצר שרוצים לייבא.
פורמט enum חובה. פורמט הקובץ לייבוא.

פורמט ערכי ENUM

FORMAT_UNSPECIFIED אין להשתמש בו.
FORMAT_TXT פורמט TXT.
FORMAT_JSONL פורמט JSONL.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

משאב: projects.locations.retailProducts

ייצוג ב-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
}

שדות


name

מחרוזת

פלט בלבד. שם המשאב של RetailProductImage

displayName

מחרוזת

אופציונלי. השם המוצג של תמונת המוצר הקמעונאי.

sourceType

enum

אופציונלי. סוג המקור

gcsUri

string

אופציונלי. מיקום ב-Cloud Storage של RetailProductImage. צריך להגדיר את המאפיין הזה, אלא אם התמונה מסופקת על ידי Google, למשל, אם סוג המקור הוא SOURCE_TYPE_GOOGLE.

resourceState

enum

פלט בלבד. המצב של RetailProductImage.

labels

map (key: string, value: string)

התוויות עם מטא-נתונים שהוגדרו על ידי המשתמש כדי לארגן את התמונה של מוצר קמעונאי.

המפתחות והערכים של התוויות יכולים להכיל עד 64 תווים (נקודות קוד של Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. אפשר להשתמש בתווים בינלאומיים.

מידע נוסף על תוויות ודוגמאות לתוויות זמינים בכתובת https://goo.gl/xmQnxf.

אובייקט שמכיל רשימה של צמדי מפתח:ערך. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (פורמט Timestamp)

פלט בלבד. חותמת הזמן של היצירה.

updateTime

string (פורמט Timestamp)

פלט בלבד. חותמת הזמן של העדכון.

RetailThirdPartyId מצגת JSON

{
  "id": string,
  "owner": string
}

שדות

id מחרוזת מזהה צד שלישי שבו משתמש הקמעונאי או היצרן (לדוגמה, מק"ט או קוד MPN).
בעלים מחרוזת הישות ש 'בבעלותה' המזהה של הצד השלישי, למשל היצרן או הקמעונאי שמוכר את המוצר הזה.

שיטה: projects.locations.retailCatalogs.retailProducts.create

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProducts

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

גוף הבקשה

גוף הבקשה מכיל מופע של RetailProduct.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של RetailProduct.

שיטה: projects.locations.retailCatalogs.retailProducts.get

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*

פרמטרים של נתיב

name מחרוזת חובה. RetailProduct מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RetailProduct.

Method: projects.locations.retailCatalogs.retailProducts.list

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProducts

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

פרמטרים של שאילתה

מסנ מחרוזת זה שינוי אופציונלי. ביטוי לסינון התוצאות של הבקשה.
pageToken מחרוזת זה שינוי אופציונלי. אסימון שמזהה איזה דף תוצאות השרת צריך להחזיר.
pageSize מספר שלם זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מצוין ערך, השרת יבחר ברירת מחדל מתאימה.
orderBy מחרוזת זה שינוי אופציונלי. רשימה מופרדת בפסיקים של שדות שלפיהם ימוינו התוצאות בסדר עולה. אחרי שם השדה, משתמשים ב-desc כדי למיין בסדר יורד.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא: ייצוג JSON

{
  "retailProducts": [
    {
      object (RetailProducts)
    }
  ],
  "nextPageToken": string
}

Method: projects.locations.retailCatalogs.retailProducts.delete

בקשת HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*

פרמטרים של נתיב

name מחרוזת חובה. RetailProduct מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

משאב: projects.locations.retailProductImages

ייצוג ב-JSON

{
  "name": string,
  "displayName": string,
  "sourceType": enum(SourceType),
  "gcsUri": string,
  "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

שדות


name

מחרוזת

פלט בלבד. שם המשאב של RetailProductImage

displayName

מחרוזת

אופציונלי. השם המוצג של תמונת המוצר הקמעונאי.

sourceType

enum

אופציונלי. סוג המקור

gcsUri

string

אופציונלי. מיקום ב-Cloud Storage של RetailProductImage. צריך להגדיר את המאפיין הזה, אלא אם התמונה מסופקת על ידי Google, למשל, אם סוג המקור הוא SOURCE_TYPE_GOOGLE.

resourceState

enum

פלט בלבד. המצב של RetailProductImage.

labels

map (key: string, value: string)

התוויות עם מטא-נתונים שהוגדרו על ידי המשתמש כדי לארגן את התמונה של מוצר קמעונאי.

המפתחות והערכים של התוויות יכולים להכיל עד 64 תווים (נקודות קוד של Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. אפשר להשתמש בתווים בינלאומיים.

מידע נוסף על תוויות ודוגמאות לתוויות זמינים בכתובת https://goo.gl/xmQnxf.

אובייקט שמכיל רשימה של צמדי מפתח: ערך. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של היצירה.

updateTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של העדכון.

ערכי ה-ENUM של SourceType

SOURCE_TYPE_UNSPECIFIED מקור נתונים לא ידוע. אין להשתמש בו.
SOURCE_TYPE_FIXED_CAMERA התמונה צולמה ממצלמה קבועה.
SOURCE_TYPE_HAND_HELD_CAMERA תמונה שצולמה במצלמה ידנית.
SOURCE_TYPE_CRAWLED התמונה נסרקת מהאינטרנט.
SOURCE_TYPE_SYSTEM_GENERATED תמונה שנחתכה מתמונה מקורית עם תיוג אנושי.

‫Method: projects.locations.retailCatalogs.retailProducts.retailProductImages.create

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*/retailProducts/*}/retailProductImages

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

גוף הבקשה

גוף הבקשה מכיל מופע של RetailProductImage.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של RetailProductImage.

Method: projects.locations.retailCatalogs.retailProducts.retailProductImages.get

בקשת HTTP

‫GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*/retailProductImages/*

פרמטרים של נתיב

name מחרוזת חובה. RetailProductImage מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RetailProductImage.

Method: projects.locations.retailCatalogs.retailProducts.retailProductImages.list

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*/retailProducts/*}/retailProductImages

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

פרמטרים של שאילתה

מסנ מחרוזת זה שינוי אופציונלי. ביטוי לסינון התוצאות של הבקשה.
pageToken מחרוזת זה שינוי אופציונלי. אסימון שמזהה איזה דף תוצאות השרת צריך להחזיר.
pageSize מספר שלם זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מצוין ערך, השרת יבחר ברירת מחדל מתאימה.
orderBy מחרוזת זה שינוי אופציונלי. רשימה מופרדת בפסיקים של שדות שלפיהם ימוינו התוצאות בסדר עולה. אחרי שם השדה, משתמשים ב-desc כדי למיין בסדר יורד.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON

{
  "retailProductImages": [
    {
      object (RetailProductImages)
    }
  ],
  "nextPageToken": string
}

‫Method: projects.locations.retailCatalogs.retailProducts.retailProductImages.delete

בקשת HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProducts/*/retailProductImages/*

פרמטרים של נתיב

name מחרוזת חובה. RetailProductImage מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

משאב: projects.locations.retailCatalogs.retailProductSets

ייצוג ב-JSON

{
  "name": string,
  "displayName": string,
  "retailProductIds": [string],
  "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

שדות


name

מחרוזת

פלט בלבד. שם המשאב של RetailProductSet

displayName

מחרוזת

אופציונלי. השם המוצג של RetailProductSet.

retailProductIds []

מחרוזת

פלט בלבד. מזהי המשאבים של מוצרים ששייכים ל-RetailProductSet הזה. המוצרים ב-RetailProductSet צריכים להיות באותו קטלוג.

resourceState

enum

פלט בלבד. המצב של RetailProductSet.

labels

map (key: string, value: string)

התוויות עם המטא-נתונים שהוגדרו על ידי המשתמש כדי לארגן את RetailProductSet.

המפתחות והערכים של התוויות יכולים להכיל עד 64 תווים (נקודות קוד של Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. אפשר להשתמש בתווים בינלאומיים.

מידע נוסף על תוויות ודוגמאות לתוויות זמינים בכתובת https://goo.gl/xmQnxf.

אובייקט שמכיל רשימה של צמדי מפתח:ערך. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (פורמט Timestamp)

פלט בלבד. חותמת הזמן של היצירה.

updateTime

string (פורמט Timestamp)

פלט בלבד. חותמת הזמן של העדכון.

‫Method: projects.locations.retailCatalogs.retailProductSets.create

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductSets

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

גוף הבקשה

גוף הבקשה מכיל מופע של RetailProductSet.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של RetailProductSet.

‫Method: projects.locations.retailCatalogs.retailProductSets.get

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*

פרמטרים של נתיב

name מחרוזת חובה. מזהה של קבוצת מוצרים קמעונאיים.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RetailProductSet.

‫Method: projects.locations.retailCatalogs.retailProductSets.list

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductSets

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

פרמטרים של שאילתה

מסנ מחרוזת זה שינוי אופציונלי. ביטוי לסינון התוצאות של הבקשה.
pageToken מחרוזת זה שינוי אופציונלי. אסימון שמזהה איזה דף תוצאות השרת צריך להחזיר.
pageSize מספר שלם זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מצוין ערך, השרת יבחר ברירת מחדל מתאימה.
orderBy מחרוזת זה שינוי אופציונלי. רשימה מופרדת בפסיקים של שדות שלפיהם ימוינו התוצאות בסדר עולה. אחרי שם השדה, משתמשים ב-desc כדי למיין בסדר יורד.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON

{
  "retailProductSets": [
    {
      object (RetailProductSets)
    }
  ],
  "nextPageToken": string
}

Method: projects.locations.retailCatalogs.retailProductSets.delete

בקשת HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*

פרמטרים של נתיב

name מחרוזת חובה. מזהה של קבוצת מוצרים קמעונאיים.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

שיטה: projects.locations.retailCatalogs.retailProductSets.add

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*}:remove

פרמטרים של נתיב

name מחרוזת חובה. שם המשאב RetailProductSet.

גוף הבקשה

ייצוג ב-JSON

{
  "productIds": [string],
  "productFilter": string
}

שדות


productIds[ ]

string

מזהה המשאב של RetailProducts שרוצים להוסיף. כולם צריכים להשתייך לאותו RetailCatalog כמו RetailProductSet היעד שצוין. אפשר לציין עד 200 מזהים של מוצרים קמעונאיים בבקשה אחת. אי אפשר להשתמש בהם יחד עם productFilter.

productFilter

string

מסנן רגיל שיחול על כל מוצרי הקמעונאות בקטלוג הקמעונאי הראשי, בוחר פריטים שעומדים בתנאי המסנן ומוסיף אותם ל-RetailProductSet. אי אפשר להשתמש בו יחד עם product_ids. מסננים נתמכים: https://google.aip.dev/160

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

Method: projects.locations.retailCatalogs.retailProductSets.remove

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductSets/*}:add

פרמטרים של נתיב

name מחרוזת חובה. שם המשאב RetailProductSet.

גוף הבקשה

ייצוג ב-JSON

{
  "productIds": [string],
  "productFilter": string
}

שדות


productIds[ ]

string

מזהי המשאבים של מוצרי הקמעונאות שרוצים להסיר. אם המוצרים הקמעונאיים שצוינו לא שייכים לקבוצת המוצרים הקמעונאיים, המערכת תתעלם מהם. אפשר לציין עד 200 מזהים של מוצרים קמעונאיים בבקשה אחת. אי אפשר להשתמש בו יחד עם המסנן products_filter.

productFilter

string

מסנן רגיל שיחול על כל RetailProduct ב-RetailProductSet שצוין. המסנן יבחר פריטים שעומדים בתנאי הסינון ויסיר אותם מ-RetailProductSet. אי אפשר להשתמש בו יחד עם product_ids. מסננים נתמכים:https://google.aip.dev/160

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

משאב: projects.locations.retailCatalogs.retailProductRecognitionIndexes

ייצוג ב-JSON

{
  "name": string,
  "displayName": string,
  "description": string,
  "retailProductSet": [string],
   "resourceState": enum(RetailResourceState),
   "labels": {
    string: string,
    ...
    }
   "createTime": string,
   "updateTime": string
}

שדות


name

מחרוזת

פלט בלבד. שם המשאב של המשאב RetailProductRecognitionIndex.

displayName

מחרוזת

אופציונלי. השם המוצג של RetailProductRecognitionIndex.

תיאור

מחרוזת

אופציונלי. התיאור של RetailProductRecognitionIndex.

retailProductSet[]

string

אופציונלי. שם המשאב של RetailProductSet שמשמש ליצירת המשאב הזה. אם המאפיין הזה מוגדר, הוא יכיל רק מוצרים ב-RetailProductSet שצוין. אם לא מגדירים את המאפיין, המערכת משתמשת בכל המוצרים בקטלוג הראשי.

resourceState

enum

פלט בלבד. המצב של RetailProductRecognitionIndex.

labels

map (key: string, value: string)

התוויות עם מטא-נתונים שהוגדרו על ידי המשתמש כדי לארגן את RetailProductRecognitionIndex.

המפתחות והערכים של התוויות יכולים להכיל עד 64 תווים (נקודות קוד של Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. אפשר להשתמש בתווים בינלאומיים.

מידע נוסף על תוויות ודוגמאות לתוויות זמינים בכתובת https://goo.gl/xmQnxf.

אובייקט שמכיל רשימה של צמדי מפתח: ערך. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של היצירה.

updateTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של העדכון.

‫Method: projects.locations.retailCatalogs.retailProductRecognitionIndexes.create

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductRecognitionIndexes

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

גוף הבקשה

גוף הבקשה מכיל מופע של RetailProductRecognitionIndex.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של RetailProductRecognitionIndex.

שיטה: projects.locations.retailCatalogs.retailProductRecognitionIndexes.get

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*

פרמטרים של נתיב

name מחרוזת חובה. RetailProductRecognitionIndex מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RetailProductRecognitionIndex.

‫Method: projects.locations.retailCatalogs.retailProductRecognitionIndexes.list

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/retailCatalogs/*}/retailProductRecognitionIndexes

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

פרמטרים של שאילתה

מסנ מחרוזת זה שינוי אופציונלי. ביטוי לסינון התוצאות של הבקשה.
pageToken מחרוזת זה שינוי אופציונלי. אסימון שמזהה איזה דף תוצאות השרת צריך להחזיר.
pageSize מספר שלם זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מצוין ערך, השרת יבחר ברירת מחדל מתאימה.
orderBy מחרוזת זה שינוי אופציונלי. רשימה מופרדת בפסיקים של שדות שלפיהם ימוינו התוצאות בסדר עולה. אחרי שם השדה, משתמשים ב-desc כדי למיין בסדר יורד.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON

{
  "retailProductRecognitionIndexes": [
    {
      object (RetailProductRecognitionIndex)
    }
  ],
  "nextPageToken": string
}

‫Method: projects.locations.retailCatalogs.retailProductRecognitionIndexes.delete

בקשת HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*

פרמטרים של נתיב

name מחרוזת חובה. מזהה של ProductRecognitionIndex.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

משאב: projects.locations.retailEndpoints

ייצוג ב-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
}

שדות


name

מחרוזת

פלט בלבד. שם המשאב של משאב RetailEndpoint.

displayName

מחרוזת

אופציונלי. השם המוצג של RetailEndpoint.

תיאור

מחרוזת

אופציונלי. התיאור של RetailEndpoint.

deployedProductRecognitionIndex

מחרוזת

פלט בלבד. שם המשאב של ProductRecognitionIndex שנפרס ב-RetailEndpoint הזה.

productRecognitionConfig

אובייקט

אופציונלי. הגדרות לזיהוי מוצרים.

tagRecognitionConfig

אובייקט

אופציונלי. הגדרות לזיהוי תגים.

resourceState

enum

פלט בלבד. המצב של RetailProductRecognitionIndex.

labels

map (key: string, value: string)

התוויות עם מטא-נתונים שהוגדרו על ידי המשתמש כדי לארגן את RetailProductRecognitionIndex.

המפתחות והערכים של התוויות יכולים להכיל עד 64 תווים (נקודות קוד של Unicode), שמורכבים רק מאותיות קטנות, ספרות, קווים תחתונים ומקפים. אפשר להשתמש בתווים בינלאומיים.

מידע נוסף על תוויות ודוגמאות לתוויות זמינים בכתובת https://goo.gl/xmQnxf.

אובייקט שמכיל רשימה של צמדי מפתח: ערך. דוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של היצירה.

updateTime

מחרוזת (פורמט Timestamp)

פלט בלבד. חותמת הזמן של העדכון.

RetailProductRecognitionConfig

ייצוג ב-JSON

{
  "productDetectionModel": string,
  "detectionConfidenceThreshold": float,
  "recognitionConfidenceThreshold": float,
  "additionalConfig": { object }
}

שדות

|

productDetectionModel מחרוזת חובה. המודל שבו יש להשתמש כדי לזהות מוצרים בתמונות קלט. הערכים הנתמכים: ‎builtin/stable (ברירת המחדל) או שם משאב של מודל Vertex AI.
detectionConfidenceThreshold מספר ממשי (float) זה שינוי אופציונלי. סף הביטחון לסינון תוצאות הזיהוי. אם לא מגדירים את המדיניות, המערכת תשתמש בערך ברירת המחדל.
recognitionConfidenceThreshold מספר ממשי (float) זה שינוי אופציונלי. סף הביטחון לסינון תוצאות הזיהוי. אם לא מגדירים את המדיניות, המערכת תשתמש בערך ברירת המחדל.
additionalConfig אובייקט (פורמט Struct) זה שינוי אופציונלי. הגדרות נוספות לזיהוי מוצרים.

RetailTagRecognitionConfig

ייצוג ב-JSON

{
  "tagDetectionModel": string,
  "tagParsingModel": string,
  "detectionConfidenceThreshold": float,
  "parsingConfidenceThreshold": float,
  "additionalConfig": { object }
}

שדות

tagDetectionModel מחרוזת חובה. מודל לשימוש בזיהוי תגים בתמונות קלט. ערכים נתמכים: משאב מודל של Vertex AI.
tagParsingModel מחרוזת חובה. מודל לניתוח טקסט בתגים שזוהו. ערכים נתמכים: משאב מודל של Vertex AI.
detectionConfidenceThreshold מספר ממשי (float) זה שינוי אופציונלי. סף הביטחון לסינון תוצאות הזיהוי. אם לא מגדירים את המדיניות, המערכת תשתמש בערך ברירת המחדל.
parsingConfidenceThreshold מספר ממשי (float) זה שינוי אופציונלי. סף המהימנות לסינון תוצאות של ניתוח טקסט. אם לא מגדירים את המדיניות, המערכת תשתמש בערך ברירת המחדל.
additionalConfig אובייקט (פורמט Struct) זה שינוי אופציונלי. הגדרות נוספות לזיהוי תגים.

‫Method: projects.locations.retailEndpoints.create

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/retailEndpoints

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

גוף הבקשה

גוף הבקשה מכיל מופע של RetailEndpoint.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של RetailEndpoint.

‫Method: projects.locations.retailEndpoints.get

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailEndpoints/*}

פרמטרים של נתיב

name מחרוזת חובה. RetailEndpoint מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של RetailEndpoint.

Method: projects.locations.retailEndpoints.list

בקשת HTTP

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*}/retailEndpoints

פרמטרים של נתיב

הורה מחרוזת חובה. מזהה ההורה.

פרמטרים של שאילתה

מסנ מחרוזת זה שינוי אופציונלי. ביטוי לסינון התוצאות של הבקשה.
pageToken מחרוזת זה שינוי אופציונלי. אסימון שמזהה איזה דף תוצאות השרת צריך להחזיר.
pageSize מספר שלם זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים ממה שביקשתם. אם לא מצוין ערך, השרת יבחר ברירת מחדל מתאימה.
orderBy מחרוזת זה שינוי אופציונלי. רשימה מופרדת בפסיקים של שדות שלפיהם ימוינו התוצאות בסדר עולה. אחרי שם השדה, משתמשים ב-desc כדי למיין בסדר יורד.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג ב-JSON

{
  "retailEndpoints": [
    {
      object (RetailEndpoint)
    }
  ],
  "nextPageToken": string
}

‫Method: projects.locations.retailEndpoints.delete

בקשת HTTP

DELETE https://visionai.googleapis.com/v1alpha1/{name=projects/*/locations/*/retailEndpoints/*

פרמטרים של נתיב

name מחרוזת חובה. RetailEndpoint מזהה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.

Method: projects.locations.retailEndpoints.deployRetailProductRecognitionIndex

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:deployRetailProductRecognitionIndex

פרמטרים של נתיב

retailEndpoint מחרוזת חובה. שם המשאב של המשאב RetailEndpoint שבו נפרס RetailProductRecognitionIndex.

גוף הבקשה

ייצוג ב-JSON

{
  "retailProductRecognitionIndex": string,
}

שדות

retailProductRecognitionIndex מחרוזת חובה. שם המשאב של RetailProductRecognitionIndex לפריסה.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

‫Method: projects.locations.retailEndpoints.undeployRetailProductRecognitionIndex

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:undeployRetailProductRecognitionIndex

פרמטרים של נתיב

retailEndpoint מחרוזת חובה. שם המשאב של משאב RetailEndpoint שעליו תתבצע הפעולה של ביטול הפריסה.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

Method: projects.locations.retailEndpoints.batchAnalyze

בקשת HTTP

POST https://visionai.googleapis.com/v1alpha1/{retailEndpoint=projects/*/locations/*/retailEndpoints/*}:batchAnalyze

פרמטרים של נתיב

retailEndpoint מחרוזת חובה. שם המשאב של RetailEndpoint שדרכו תוגש בקשת ההסקה.

גוף הבקשה

ייצוג ב-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
}

שדות

gcsSource מחרוזת חובה. המיקום ב-Cloud Storage של תוכן הקלט. אפשר לספק כמה מיקומי קלט. התוכן של כל מיקומי הקלט יעובד באצווה אחת. תוכן נתמך: קובץ TXT, שכל שורה בו היא הנתיב המלא לתמונה. אפשר לתמוך בעד 50,000 תמונות בבקשה אחת.
outputGcsDestination מחרוזת זה שינוי אופציונלי. המיקום ב-Cloud Storage של הספרייה שאליה ייכתב הפלט.
קורפוס מחרוזת זה שינוי אופציונלי. שם המשאב של מאגר התמונות. עדיין לא נתמך.
bigqueryTable מחרוזת זה שינוי אופציונלי. שם המשאב של טבלת BigQuery לייצוא הערות. בפורמט של 'projects/*/datasets/*/tables/*‎'. אם הגדרתם ייצוא, גם הערות שנוצרו מהסקת מסקנות של ML ייוצאו לטבלת BigQuery שציינתם. עדיין לא נתמך.
features[] אובייקט חובה. סוג ההסקה של למידת מכונה שצריך לבצע.

תכונה

ייצוג ב-JSON

{
  "type": enum(Type),
  "productRecognitionConfig": object(RetailProductRecognitionConfig),
  "tagRecognitionConfig": object(RetailTagRecognitionConfig)
}

שדות

סוג enum חובה. סוג התכונה.
productRecognitionConfig אובייקט זה שינוי אופציונלי. שינויים שחלים על כל בקשה בנפרד בתכונה לזיהוי מוצרים. הוא תקף רק אם הסוג מוגדר כ-TYPE_PRODUCT_RECOGNITION.
tagRecognitionConfig אובייקט זה שינוי אופציונלי. לכל בקשה החלפות של תכונת זיהוי התגים. היא יעילה רק אם הסוג מוגדר כ-TYPE_TAG_RECOGNITION.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

סוגים

GcsSource

ייצוג ב-JSON

{
  "uris": [string]
}

שדות

uris[] מחרוזת חובה. הפניות לנתיבים ב-Cloud Storage.

סוג

ערכי ENUM

TYPE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
TYPE_PRODUCT_RECOGNITION זיהוי מוצרים. חובה להשתמש ב-RetailEndpoint עם RetailProductRecognitionIndex שמוטמע.
TYPE_TAG_RECOGNITION זיהוי וניתוח של תגים. חובה להשתמש בה ב-RetailEndpoint עם RetailTagRecognitionConfig.

RetailProductIoFormat

ייצוג ב-JSON

{
  "retailProduct": { object(RetailProduct) },
  "retailProductImages": [ { object(RetailProductImage) }]
}

שדות

retailProduct אובייקט חובה. RetailProduct לייבוא
retailProductImages[ ] אובייקט אופציונלי. RetailProductImages של RetailProduct שרוצים לייבא.

RetailResourceState

ערכי ENUM

RETAIL_RESOURCE_STATE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
RETAIL_RESOURCE_STATE_CREATING המצב הוא 'יצירה'.
RETAIL_RESOURCE_STATE_CREATED מצב נוצר.
RETAIL_RESOURCE_STATE_UPDATING מתבצע עדכון של הסטטוס.
RETAIL_RESOURCE_STATE_DELETED המצב הוא 'נמחק'.
RETAIL_RESOURCE_STATE_ERROR שגיאת מצב.