Package google.cloud.vision.v1

אינדקס

ImageAnnotator

שירות שמבצע משימות זיהוי של Google Cloud Vision API בתמונות של לקוחות, כמו זיהוי פנים, ציוני דרך, לוגו, תוויות וטקסט. שירות ImageAnnotator מחזיר ישויות שזוהו בתמונות.

AsyncBatchAnnotateFiles

rpc AsyncBatchAnnotateFiles(AsyncBatchAnnotateFilesRequest) returns (Operation)

הפעלת זיהוי תמונות והוספת הערות אסינכרוניים לרשימה של קבצים כלליים, כמו קובצי PDF, שעשויים להכיל כמה דפים וכמה תמונות בכל דף. אפשר לאחזר את ההתקדמות והתוצאות דרך הממשק של google.longrunning.Operations. ‫Operation.metadata contains OperationMetadata (מטא-נתונים). Operation.response עם AsyncBatchAnnotateFilesResponse (תוצאות).

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
AsyncBatchAnnotateImages

rpc AsyncBatchAnnotateImages(AsyncBatchAnnotateImagesRequest) returns (Operation)

הפעלת זיהוי והוספת הערות לתמונות באופן אסינכרוני לרשימה של תמונות.

אפשר לאחזר את ההתקדמות והתוצאות דרך הממשק של google.longrunning.Operations. ‫Operation.metadata contains OperationMetadata (מטא-נתונים). Operation.response עם AsyncBatchAnnotateImagesResponse (תוצאות).

שירות זה יכתוב את הפלטים של הערות לתמונות לקובצי JSON בקטגוריה של Google Cloud Storage של הלקוח. כל קובץ JSON יכיל פרוטו של BatchAnnotateImagesResponse.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
BatchAnnotateFiles

rpc BatchAnnotateFiles(BatchAnnotateFilesRequest) returns (BatchAnnotateFilesResponse)

שירות שמבצע זיהוי תמונות והוספת הערות לקבוצת קבצים. עכשיו יש תמיכה רק בערכים application/pdf,‏ image/tiff ו-image/gif.

השירות הזה יחלץ לכל היותר 5 פריימים (gif) או דפים (pdf או tiff) מכל קובץ שיישלח, ויבצע זיהוי והוספת הערות לכל תמונה שחולצה. (הלקוחות יכולים לציין אילו 5 פריימים או דפים לחלץ באמצעות AnnotateFileRequest.pages).

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
BatchAnnotateImages

rpc BatchAnnotateImages(BatchAnnotateImagesRequest) returns (BatchAnnotateImagesResponse)

הפעלת זיהוי תמונות והוספת הערות לקבוצת תמונות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.

ProductSearch

מנהל מוצרים וקבוצות מוצרים של תמונות להשוואה לשימוש בחיפוש מוצרים. הוא משתמש במודל המשאבים הבא:

  • ל-API יש אוסף של ProductSet משאבים, שנקראים projects/*/locations/*/productSets/*, שמשמשים לקיבוץ של מוצרים שונים כדי להגביל את הזיהוי.

במקביל,

  • ל-API יש אוסף של משאבי Product, שנקראים projects/*/locations/*/products/*

  • לכל Product יש אוסף של משאבי ReferenceImage, שנקראים projects/*/locations/*/products/*/referenceImages/*

AddProductToProductSet

rpc AddProductToProductSet(AddProductToProductSetRequest) returns (Empty)

הוספת מוצר ל-ProductSet שצוין. אם המוצר כבר קיים, לא יבוצע שינוי.

אפשר להוסיף מוצר אחד ל-100 קבוצות מוצרים לכל היותר.

שגיאות אפשריות:

  • הפונקציה מחזירה NOT_FOUND אם המוצר או קבוצת המוצרים לא קיימים.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
CreateProduct

rpc CreateProduct(CreateProductRequest) returns (Product)

יוצרת משאב מוצר חדש ומחזירה אותו.

שגיאות אפשריות:

  • הפונקציה מחזירה INVALID_ARGUMENT אם הערך של display_name חסר או ארוך מ-4,096 תווים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם התיאור ארוך מ-4,096 תווים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם המאפיין product_category חסר או לא תקין.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
CreateProductSet

rpc CreateProductSet(CreateProductSetRequest) returns (ProductSet)

יוצרת משאב ProductSet חדש ומחזירה אותו.

שגיאות אפשריות:

  • הפונקציה מחזירה INVALID_ARGUMENT אם הערך של display_name חסר או ארוך מ-4, 096 תווים.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
CreateReferenceImage

rpc CreateReferenceImage(CreateReferenceImageRequest) returns (ReferenceImage)

יוצרת ומחזירה משאב ReferenceImage חדש.

השדה bounding_poly הוא אופציונלי. אם לא מציינים את bounding_poly, המערכת תנסה לזהות באזורים בתמונה שמתאימים לערך של product_category במוצר האב. אם מציינים את זה, המערכת תמיד מדלגת על הזיהוי. המערכת ממירה מצולעים למלבנים לא מסובבים.

שימו לב: אם הרזולוציה של התמונה גדולה מדי לעיבוד (מעל 50MP), הצינור יקטין את התמונה.

שגיאות אפשריות:

  • הפונקציה מחזירה INVALID_ARGUMENT אם חסר image_uri או אם הוא ארוך מ-4,096 תווים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם המוצר לא קיים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם לא צוין bounding_poly, ולא זוהה דבר שתואם ל-product_category של מוצר האב.
  • הפונקציה מחזירה INVALID_ARGUMENT אם bounding_poly מכיל יותר מ-10 מצולעים.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
DeleteProduct

rpc DeleteProduct(DeleteProductRequest) returns (Empty)

מחיקה סופית של מוצר ותמונות הייחוס שלו.

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
DeleteProductSet

rpc DeleteProductSet(DeleteProductSetRequest) returns (Empty)

מחיקה סופית של ProductSet. המוצרים והתמונות הייחוס ב-ProductSet לא נמחקים.

קבצי התמונות בפועל לא נמחקים מ-Google Cloud Storage.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
DeleteReferenceImage

rpc DeleteReferenceImage(DeleteReferenceImageRequest) returns (Empty)

מחיקה סופית של תמונה לדוגמה.

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

קבצי התמונות בפועל לא נמחקים מ-Google Cloud Storage.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
GetProduct

rpc GetProduct(GetProductRequest) returns (Product)

קבלת מידע שמשויך למוצר.

שגיאות אפשריות:

  • הפונקציה מחזירה NOT_FOUND אם המוצר לא קיים.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
GetProductSet

rpc GetProductSet(GetProductSetRequest) returns (ProductSet)

קבלת מידע שמשויך ל-ProductSet.

שגיאות אפשריות:

  • הפונקציה מחזירה NOT_FOUND אם ProductSet לא קיים.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
GetReferenceImage

rpc GetReferenceImage(GetReferenceImageRequest) returns (ReferenceImage)

קבלת מידע שמשויך ל-ReferenceImage.

שגיאות אפשריות:

  • הפונקציה מחזירה NOT_FOUND אם התמונה שצוינה לא קיימת.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
ImportProductSets

rpc ImportProductSets(ImportProductSetsRequest) returns (Operation)

ממשק API אסינכרוני שמייבא רשימה של תמונות לדוגמה לקבוצות מוצרים שצוינו, על סמך רשימה של פרטי תמונות.

אפשר להשתמש ב-API‏ google.longrunning.Operation כדי לעקוב אחרי ההתקדמות והתוצאות של הבקשה. Operation.metadata מכיל BatchOperationMetadata. ‫(progress) Operation.response מכיל ImportProductSetsResponse. (תוצאות)

מקור הקלט של השיטה הזו הוא קובץ CSV ב-Google Cloud Storage. למידע על הפורמט של קובץ ה-CSV, אפשר לעיין במאמר ImportProductSetsGcsSource.csv_file_uri.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
ListProductSets

rpc ListProductSets(ListProductSetsRequest) returns (ListProductSetsResponse)

הפונקציה מחזירה רשימה של ProductSets בסדר לא מוגדר.

שגיאות אפשריות:

  • הפונקציה מחזירה INVALID_ARGUMENT אם page_size גדול מ-100 או קטן מ-1.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse)

רשימת מוצרים בסדר לא מוגדר.

שגיאות אפשריות:

  • הפונקציה מחזירה INVALID_ARGUMENT אם page_size גדול מ-100 או קטן מ-1.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
ListProductsInProductSet

rpc ListProductsInProductSet(ListProductsInProductSetRequest) returns (ListProductsInProductSetResponse)

רשימת המוצרים ב-ProductSet, בסדר לא מוגדר. אם קבוצת המוצרים לא קיימת, השדה 'מוצרים' בתשובה יהיה ריק.

שגיאות אפשריות:

  • הפונקציה מחזירה INVALID_ARGUMENT אם page_size גדול מ-100 או קטן מ-1.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
ListReferenceImages

rpc ListReferenceImages(ListReferenceImagesRequest) returns (ListReferenceImagesResponse)

רשימה של תמונות לדוגמה.

שגיאות אפשריות:

  • הפונקציה מחזירה את הערך NOT_FOUND אם מוצר האב לא קיים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם הערך של page_size גדול מ-100 או קטן מ-1.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
PurgeProducts

rpc PurgeProducts(PurgeProductsRequest) returns (Operation)

‫API אסינכרוני למחיקת כל המוצרים ב-ProductSet או כל המוצרים שלא נמצאים ב-ProductSet.

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

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

אי אפשר לבטל את הפעולה PurgeProducts. לכן, מומלץ לשמור את קובצי ה-CSV שבהם השתמשתם ב-ImportProductSets (אם כך יצרתם את קבוצת המוצרים במקור) לפני שמתחילים את PurgeProducts, למקרה שתצטרכו לייבא מחדש את הנתונים אחרי המחיקה.

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

אפשר להשתמש ב-API‏ google.longrunning.Operation כדי לעקוב אחרי ההתקדמות והתוצאות של הבקשה. Operation.metadata מכיל BatchOperationMetadata. (התקדמות)

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
RemoveProductFromProductSet

rpc RemoveProductFromProductSet(RemoveProductFromProductSetRequest) returns (Empty)

מסיר מוצר מ-ProductSet שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
UpdateProduct

rpc UpdateProduct(UpdateProductRequest) returns (Product)

ביצוע שינויים במשאב Product. בשלב הזה אפשר לעדכן רק את השדות display_name,‏ description ו-labels.

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

שגיאות אפשריות:

  • הפונקציה מחזירה NOT_FOUND אם המוצר לא קיים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם display_name מופיע ב-update_mask אבל חסר בבקשה או ארוך יותר מ-4,096 תווים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם התיאור מופיע ב-update_mask אבל ארוך מ-4,096 תווים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם product_category מופיע ב-update_mask.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.
UpdateProductSet

rpc UpdateProductSet(UpdateProductSetRequest) returns (ProductSet)

מבצע שינויים במשאב ProductSet. אפשר לעדכן כרגע רק את הערך של display_name.

שגיאות אפשריות:

  • הפונקציה מחזירה NOT_FOUND אם ProductSet לא קיים.
  • הפונקציה מחזירה INVALID_ARGUMENT אם display_name מופיע ב-update_mask אבל חסר בבקשה או ארוך יותר מ-4,096 תווים.
היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-vision

מידע נוסף מופיע במאמר סקירה כללית על אימות.

AddProductToProductSetRequest

הודעת בקשה לשיטה AddProductToProductSet.

שדות
name

string

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

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

חובה. שם המשאב של המוצר שרוצים להוסיף ל-ProductSet הזה.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

AnnotateFileRequest

בקשה להוספת הערות לקובץ אחד, למשל קובץ PDF, ‏ TIFF או GIF.

שדות
input_config

InputConfig

חובה. מידע על קובץ הקלט.

features[]

Feature

חובה. תכונות מבוקשות.

image_context

ImageContext

הקשר נוסף שעשוי להופיע לצד התמונות בקובץ.

pages[]

int32

הדפים בקובץ שבהם רוצים לבצע הערות לתמונות.

הדפים מתחילים מ-1, אנחנו מניחים שהדף הראשון בקובץ הוא דף 1. כל בקשה יכולה לכלול עד 5 דפים. הערך של Pages יכול להיות שלילי.

‫Page 1 (עמוד 1) מייצג את העמוד הראשון. ‫Page 2 פירושו הדף השני. הדף -1 הוא הדף האחרון. הדף -2 הוא הדף השני לפני האחרון.

אם הקובץ הוא GIF במקום PDF או TIFF, המונח 'דף' מתייחס למסגרות GIF.

אם השדה הזה ריק, כברירת מחדל השירות מבצע הערות לתמונות ב-5 הדפים הראשונים של הקובץ.

AnnotateFileResponse

תשובה לבקשה להוספת הערה לקובץ יחיד. קובץ יכול להכיל תמונה אחת או יותר, ולכל תמונה יש תשובות משלה.

שדות
input_config

InputConfig

מידע על הקובץ שעבורו נוצרה התשובה הזו.

responses[]

AnnotateImageResponse

תשובות ספציפיות לתמונות שנמצאות בקובץ. השדה הזה יהיה ריק אם השדה error מוגדר.

total_pages

int32

בשדה הזה מופיע המספר הכולל של העמודים בקובץ.

error

Status

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

AnnotateImageRequest

בקשה לביצוע משימות של Google Cloud Vision API על תמונה שהמשתמש סיפק, עם תכונות שהמשתמש ביקש ועם מידע הקשרי.

שדות
image

Image

התמונה לעיבוד.

features[]

Feature

תכונות מבוקשות.

image_context

ImageContext

הקשר נוסף שאולי יצורף לתמונה.

AnnotateImageResponse

תשובה לבקשה להערת תמונה.

שדות
face_annotations[]

FaceAnnotation

אם יש פנים בתמונה, זיהוי הפנים הושלם בהצלחה.

landmark_annotations[]

EntityAnnotation

אם יש נקודת ציון, זיהוי נקודת הציון הושלם בהצלחה.

logo_annotations[]

EntityAnnotation

אם יש לוגו, זיהוי הלוגו הושלם בהצלחה.

label_annotations[]

EntityAnnotation

אם יש תווית, זיהוי התווית הושלם בהצלחה.

localized_object_annotations[]

LocalizedObjectAnnotation

אם יש, זיהוי האובייקטים המותאם לשפה המקומית הושלם בהצלחה. התוצאות ימוינו בסדר יורד לפי ציון הסמך.

text_annotations[]

EntityAnnotation

אם יש טקסט, זיהוי הטקסט (OCR) הושלם בהצלחה.

full_text_annotation

TextAnnotation

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

safe_search_annotation

SafeSearchAnnotation

אם יש הערה לגבי חיפוש בטוח, היא הושלמה בהצלחה.

image_properties_annotation

ImageProperties

אם קיימים מאפייני תמונה, הם חולצו בהצלחה.

crop_hints_annotation

CropHintsAnnotation

אם יש רמזים לחיתוך, הם הושלמו בהצלחה.

web_detection

WebDetection

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

product_search_results

ProductSearchResults

אם יש תוצאות, החיפוש הושלם בהצלחה.

error

Status

אם מוגדר, מייצג את הודעת השגיאה של הפעולה. שימו לב שההערות לתמונות שמולאו הן נכונות בוודאות, גם אם הערך של error מוגדר.

context

ImageAnnotationContext

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

AsyncAnnotateFileRequest

בקשה להערה בקובץ אופליין.

שדות
input_config

InputConfig

חובה. מידע על קובץ הקלט.

features[]

Feature

חובה. תכונות מבוקשות.

image_context

ImageContext

הקשר נוסף שעשוי להופיע לצד התמונות בקובץ.

output_config

OutputConfig

חובה. מיקום הפלט הרצוי ומטא-נתונים (למשל, פורמט).

AsyncAnnotateFileResponse

התשובה לבקשה יחידה להוספת הערה לקובץ אופליין.

שדות
output_config

OutputConfig

מיקום הפלט והמטא-נתונים מ-AsyncAnnotateFileRequest.

AsyncBatchAnnotateFilesRequest

כמה בקשות אסינכרוניות להערות בקובץ מקובצות לקריאה אחת לשירות.

שדות
requests[]

AsyncAnnotateFileRequest

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

parent

string

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

פורמט: projects/{project-id}/locations/{location-id}

אם לא מציינים הורה, המערכת תבחר אזור באופן אוטומטי.

מזהי מיקום נתמכים: us: ארה"ב בלבד, asia: אזורים במזרח אסיה, כמו יפן וטייוואן, eu: האיחוד האירופי.

דוגמה: projects/project-A/locations/eu

AsyncBatchAnnotateFilesResponse

תשובה לבקשה אסינכרונית להערות בקובץ באצווה.

שדות
responses[]

AsyncAnnotateFileResponse

רשימת התגובות של הערות לקבצים, אחת לכל בקשה ב-AsyncBatchAnnotateFilesRequest.

AsyncBatchAnnotateImagesRequest

בקשה להוספת הערות לתמונות באופן אסינכרוני לרשימה של תמונות.

שדות
requests[]

AnnotateImageRequest

חובה. בקשות נפרדות להערות לתמונות באצווה הזו.

output_config

OutputConfig

חובה. מיקום הפלט הרצוי ומטא-נתונים (למשל, פורמט).

parent

string

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

פורמט: projects/{project-id}/locations/{location-id}

אם לא מציינים הורה, המערכת תבחר אזור באופן אוטומטי.

מזהי מיקום נתמכים: us: ארה"ב בלבד, asia: אזורים במזרח אסיה, כמו יפן וטייוואן, eu: האיחוד האירופי.

דוגמה: projects/project-A/locations/eu

AsyncBatchAnnotateImagesResponse

תשובה לבקשה אסינכרונית להערות לתמונות באצווה.

שדות
output_config

OutputConfig

מיקום הפלט והמטא-נתונים מ-AsyncBatchAnnotateImagesRequest.

BatchAnnotateFilesRequest

רשימה של בקשות להוספת הערות לקבצים באמצעות BatchAnnotateFiles API.

שדות
requests[]

AnnotateFileRequest

חובה. רשימת הבקשות להערות בקובץ. בשלב הזה אנחנו תומכים רק ב-AnnotateFileRequest אחד ב-BatchAnnotateFilesRequest.

parent

string

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

פורמט: projects/{project-id}/locations/{location-id}

אם לא מציינים הורה, המערכת תבחר אזור באופן אוטומטי.

מזהי מיקום נתמכים: us: ארה"ב בלבד, asia: אזורים במזרח אסיה, כמו יפן וטייוואן, eu: האיחוד האירופי.

דוגמה: projects/project-A/locations/eu

BatchAnnotateFilesResponse

רשימה של תגובות לאנוטציות של קבצים.

שדות
responses[]

AnnotateFileResponse

רשימת התגובות של הערות הקבצים, כאשר כל תגובה מתאימה לכל AnnotateFileRequest ב-BatchAnnotateFilesRequest.

BatchAnnotateImagesRequest

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

שדות
requests[]

AnnotateImageRequest

חובה. בקשות נפרדות להערות לתמונות באצווה הזו.

parent

string

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

פורמט: projects/{project-id}/locations/{location-id}

אם לא מציינים הורה, המערכת תבחר אזור באופן אוטומטי.

מזהי מיקום נתמכים: us: ארה"ב בלבד, asia: אזורים במזרח אסיה, כמו יפן וטייוואן, eu: האיחוד האירופי.

דוגמה: projects/project-A/locations/eu

BatchAnnotateImagesResponse

תשובה לבקשה באצווה להוספת הערות לתמונות.

שדות
responses[]

AnnotateImageResponse

תשובות נפרדות לבקשות להערות לתמונות באצווה.

BatchOperationMetadata

מטא-נתונים של פעולות על כמויות גדולות, כמו המצב הנוכחי.

הערך הזה כלול בשדה metadata של Operation שמוחזר על ידי קריאת GetOperation של שירות google::longrunning::Operations.

שדות
state

State

המצב הנוכחי של פעולת האצווה.

submit_time

Timestamp

השעה שבה בקשת Batch נשלחה לשרת.

end_time

Timestamp

הזמן שבו בקשת Batch מסתיימת והערך של google.longrunning.Operation.done מוגדר כ-true.

מדינה

מפרט את הסטטוסים האפשריים של בקשת Batch.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED יש שגיאה.
PROCESSING הבקשה נמצאת בעיבוד.
SUCCESSFUL הבקשה הושלמה ולפחות פריט אחד עבר עיבוד בהצלחה.
FAILED הבקשה הסתיימה ולא בוצע עיבוד של אף פריט.
CANCELLED הבקשה מתבצעת אחרי שהמשתמש קורא ל-longrunning.Operations.CancelOperation. כל הרשומות שעברו עיבוד לפני פקודת הביטול יוצגו כפי שצוין בבקשה.

חסימה

רכיב לוגי בדף.

שדות
property

TextProperty

מידע נוסף שזוהה לגבי החסימה.

bounding_box

BoundingPoly

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

  • כשהטקסט אופקי, הוא יכול להיראות כך:
    0----1
    |    |
    3----2
  • כשמסובבים אותו ב-180 מעלות סביב הפינה הימנית העליונה הוא הופך ל:
    2----3
    |    |
    1----0

וסדר הקודקודים יישאר (0, 1, 2, 3).
paragraphs[]

Paragraph

רשימת הפסקאות בבלוק הזה (אם הבלוק הוא מסוג טקסט).

block_type

BlockType

סוג הבלוק שזוהה (טקסט, תמונה וכו') עבור הבלוק הזה.

confidence

float

רמת המהימנות של תוצאות ה-OCR בבלוק. טווח [0, 1].

BlockType

סוג הבלוק (טקסט, תמונה וכו') כפי שזוהה על ידי OCR.

טיפוסים בני מנייה (enum)
UNKNOWN סוג הבלוק לא ידוע.
TEXT בלוק טקסט רגיל.
TABLE בלוק של טבלה.
PICTURE חסימת תמונה.
RULER תיבה עם קו אופקי או אנכי.
BARCODE בלוק ברקוד.

BoundingPoly

פוליגון תיחום להערת התמונה שזוהתה.

שדות
vertices[]

Vertex

הקודקודים של הפוליגון התוחם.

normalized_vertices[]

NormalizedVertex

הקודקודים המנורמלים של הפוליגון התוחם.

ColorInfo

מידע על צבע כולל ערוצי RGB, ציון ושבריר התמונה שהצבע תופס בתמונה.

שדות
color

Color

רכיבי ה-RGB של הצבע.

score

float

ציון ספציפי לתמונה של הצבע הזה. הערך בטווח [0, 1].

pixel_fraction

float

החלק היחסי של הפיקסלים שהצבע תופס בתמונה. הערך בטווח [0, 1].

CreateProductRequest

הודעת בקשה לשיטה CreateProduct.

שדות
parent

string

חובה. הפרויקט שבו צריך ליצור את המוצר.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID.
product

Product

חובה. המוצר שרוצים ליצור.

product_id

string

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

CreateProductSetRequest

הודעת בקשה לשיטה CreateProductSet.

שדות
parent

string

חובה. הפרויקט שבו צריך ליצור את ProductSet.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID.
product_set

ProductSet

חובה. ה-ProductSet שרוצים ליצור.

product_set_id

string

מזהה משאב שסופק על ידי המשתמש עבור ProductSet. אם הערך מוגדר, השרת ינסה להשתמש בו כמזהה המשאב. אם הוא כבר בשימוש, מוחזרת שגיאה עם הקוד ALREADY_EXISTS. האורך המקסימלי הוא 128 תווים. היא לא יכולה להכיל את התו /.

CreateReferenceImageRequest

הודעת בקשה לשיטה CreateReferenceImage.

שדות
parent

string

חובה. שם המשאב של המוצר שבו רוצים ליצור את תמונת הדוגמה.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
reference_image

ReferenceImage

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

reference_image_id

string

מזהה משאב שסופק על ידי המשתמש עבור ReferenceImage שרוצים להוסיף. אם הערך מוגדר, השרת ינסה להשתמש בו כמזהה המשאב. אם הוא כבר בשימוש, מוחזרת שגיאה עם הקוד ALREADY_EXISTS. האורך המקסימלי הוא 128 תווים. היא לא יכולה להכיל את התו /.

CropHint

רמז לחיתוך יחיד שמשמש ליצירת חיתוך חדש כשמציגים תמונה.

שדות
bounding_poly

BoundingPoly

המצולע התוחם של אזור החיתוך. הקואורדינטות של התיבה התוחמת הן בסקאלה של התמונה המקורית.

confidence

float

רמת הביטחון שמדובר באזור בולט. טווח [0, 1].

importance_fraction

float

חלק החשיבות של האזור הבולט הזה ביחס לתמונה המקורית.

CropHintsAnnotation

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

שדות
crop_hints[]

CropHint

תוצאות של הצעות חיתוך.

CropHintsParams

פרמטרים לבקשת הערות לגבי הצעות לחיתוך.

שדות
aspect_ratios[]

float

יחסי גובה-רוחב במספרים עשרוניים, שמייצגים את היחס בין הרוחב לגובה של התמונה. לדוגמה, אם יחס הגובה-רוחב הרצוי הוא 4/3, הערך המתאים של הנקודה הצפה צריך להיות 1.33333. אם לא מציינים ערך, המערכת מחזירה את החיתוך הטוב ביותר האפשרי. מספר יחסי הגובה-רוחב שסופקו מוגבל ל-16 לכל היותר. המערכת מתעלמת מיחסי גובה-רוחב שסופקו אחרי ה-16.

DeleteProductRequest

הודעת בקשה לשיטה DeleteProduct.

שדות
name

string

חובה. שם המשאב של המוצר שרוצים למחוק.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

DeleteProductSetRequest

הודעת בקשה לשיטה DeleteProductSet.

שדות
name

string

חובה. שם המשאב של קבוצת המוצרים שרוצים למחוק.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

DeleteReferenceImageRequest

הודעת בקשה לשיטה DeleteReferenceImage.

שדות
name

string

חובה. שם המשאב של התמונה לדוגמה שרוצים למחוק.

הפורמט הוא:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID

DominantColorsAnnotation

קבוצה של צבעים דומיננטיים והציונים התואמים שלהם.

שדות
colors[]

ColorInfo

ערכי צבעי RGB עם הציון והחלק היחסי של הפיקסלים.

EntityAnnotation

קבוצה של תכונות ישות שאותרו.

שדות
mid

string

מזהה ישות אטום. יכול להיות שחלק מהמזהים זמינים ב-Google Knowledge Graph Search API.

locale

string

קוד השפה של הלוקאל שבו מבוטא הטקסט של הישות description.

description

string

תיאור טקסטואלי של הישות, בשפה locale שלה.

score

float

הציון הכולל של התוצאה. טווח [0, 1].

confidence
(deprecated)

float

הוּצאה משימוש במקום זאת, אתם צריכים להשתמש ב-score. מידת הדיוק של זיהוי הישות בתמונה. לדוגמה, אם מזוהה בתמונה הישות 'מגדל אייפל', השדה הזה מייצג את רמת הביטחון שיש מגדל בתמונה של השאילתה. טווח [0, 1].
topicality

float

רמת הרלוונטיות של התווית ICA (הערה על תוכן התמונה) לתמונה. לדוגמה, סביר להניח שהרלוונטיות של המילה 'מגדל' גבוהה יותר לתמונה שבה זוהה 'מגדל אייפל' מאשר לתמונה שבה זוהה בניין גבוה רחוק, גם אם רמת הוודאות לגבי קיומו של מגדל בכל אחת מהתמונות זהה. טווח [0, 1].

bounding_poly

BoundingPoly

אזור התמונה שהישות הזו שייכת לו. לא נוצר עבור תכונות של LABEL_DETECTION.

locations[]

LocationInfo

נתוני המיקום של הישות שזוהתה. יכולים להיות כמה אלמנטים מסוג LocationInfo כי מיקום אחד יכול לציין את המיקום של הסצנה בתמונה, ומיקום אחר יכול לציין את המיקום של המקום שבו התמונה צולמה. בדרך כלל יש פרטי מיקום לגבי ציוני דרך.

properties[]

Property

לחלק מהישויות עשויים להיות שדות אופציונליים שסופקו על ידי המשתמש Property (שם/ערך), כמו ציון או מחרוזת שמסווגים את הישות.

FaceAnnotation

אובייקט של הערת פנים מכיל את התוצאות של זיהוי הפנים.

שדות
bounding_poly

BoundingPoly

פוליגון התוחם סביב הפנים. הקואורדינטות של התיבה התוחמת הן בסקאלה של התמונה המקורית. תיבת התוחמת מחושבת כדי "למסגר" את הפנים בהתאם לציפיות של בני אדם. הוא מבוסס על תוצאות של ציוני דרך. שימו לב שאם רק חלק מהפנים מופיע בתמונה שצריך להוסיף לה הערה, יכול להיות שלא ייווצר ערך לאחת או יותר מהקואורדינטות x או y ב-BoundingPoly (המצולע לא יהיה חסום).

fd_bounding_poly

BoundingPoly

המצולע התוחם fd_bounding_poly קטן יותר מהמצולע boundingPoly, והוא כולל רק את החלק של העור בפנים. בדרך כלל, משתמשים בה כדי להסיר את הפנים מכל ניתוח תמונה שמזהה את 'כמות העור' שרואים בתמונה. הוא לא מבוסס על תוצאות של נקודות ציון, אלא רק על זיהוי הפנים הראשוני, ולכן

fd

(זיהוי פנים).
landmarks[]

Landmark

זוהו נקודות ציון של פנים.

roll_angle

float

זווית הגלגול, שמציינת את מידת הסיבוב של הפנים בכיוון השעון או נגד כיוון השעון ביחס לאנך של התמונה סביב הציר שמאונך לפנים. הטווח הוא [‎-180,180].

pan_angle

float

זווית הסבסוב, שמציינת את הזווית שבה הפנים מצביעות שמאלה או ימינה ביחס למישור האנכי שמאונך לתמונה. הטווח הוא [‎-180,180].

tilt_angle

float

זווית עלרוד, שמציינת את הזווית כלפי מעלה או כלפי מטה שאליה פונות הפנים ביחס למישור האופקי של התמונה. הטווח הוא [‎-180,180].

detection_confidence

float

רמת הביטחון בזיהוי. טווח [0, 1].

landmarking_confidence

float

רמת הביטחון של זיהוי נקודות ציון בפנים. טווח [0, 1].

joy_likelihood

Likelihood

סבירות להבעת שמחה.

sorrow_likelihood

Likelihood

סבירות להבעת צער.

anger_likelihood

Likelihood

סבירות לכעס.

surprise_likelihood

Likelihood

הסיכוי להפתעה.

under_exposed_likelihood

Likelihood

הסבירות לחשיפה נמוכה מדי.

blurred_likelihood

Likelihood

סבירות מטושטשת.

headwear_likelihood

Likelihood

הסבירות לשימוש בכיסוי ראש.

ציון דרך

נקודת ציון ספציפית בפנים (לדוגמה, תווי פנים).

שדות
type

Type

סוג נקודת ציון בפנים.

position

Position

מיקום של נקודת ציון בפנים.

סוג

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

טיפוסים בני מנייה (enum)
UNKNOWN_LANDMARK זוהה סמן לא מוכר של פנים. אין למלא את השדה הזה.
LEFT_EYE העין השמאלית.
RIGHT_EYE העין הימנית.
LEFT_OF_LEFT_EYEBROW משמאל לגבה השמאלית.
RIGHT_OF_LEFT_EYEBROW מימין לגבה השמאלית.
LEFT_OF_RIGHT_EYEBROW משמאל לגבה הימנית.
RIGHT_OF_RIGHT_EYEBROW מימין לגבה הימנית.
MIDPOINT_BETWEEN_EYES נקודת האמצע בין העיניים.
NOSE_TIP קצה האף.
UPPER_LIP שפה עליונה.
LOWER_LIP השפה התחתונה.
MOUTH_LEFT פה שמאלה.
MOUTH_RIGHT הפה ימינה.
MOUTH_CENTER מרכז הפה.
NOSE_BOTTOM_RIGHT אף, צד ימין למטה.
NOSE_BOTTOM_LEFT אף, פינה שמאלית תחתונה.
NOSE_BOTTOM_CENTER אף, במרכז למטה.
LEFT_EYE_TOP_BOUNDARY העין השמאלית, הגבול העליון.
LEFT_EYE_RIGHT_CORNER עין שמאל, פינה ימנית.
LEFT_EYE_BOTTOM_BOUNDARY העין השמאלית, הגבול התחתון.
LEFT_EYE_LEFT_CORNER העין השמאלית, הפינה השמאלית.
RIGHT_EYE_TOP_BOUNDARY הגבול העליון של העין הימנית.
RIGHT_EYE_RIGHT_CORNER עין ימין, פינה ימנית.
RIGHT_EYE_BOTTOM_BOUNDARY עין ימין, גבול תחתון.
RIGHT_EYE_LEFT_CORNER עין ימין, פינה שמאלית.
LEFT_EYEBROW_UPPER_MIDPOINT הגבה השמאלית, נקודת האמצע העליונה.
RIGHT_EYEBROW_UPPER_MIDPOINT הגבה הימנית, נקודת האמצע העליונה.
LEFT_EAR_TRAGION החלק הקדמי של האוזן השמאלית.
RIGHT_EAR_TRAGION החלק הקדמי של תנוך האוזן הימנית.
LEFT_EYE_PUPIL האישון בעין שמאל.
RIGHT_EYE_PUPIL האישון בעין ימין.
FOREHEAD_GLABELLA פדחת.
CHIN_GNATHION סנטר (Gnathion).
CHIN_LEFT_GONION הסנטר משמאל לזווית הלסת.
CHIN_RIGHT_GONION סנטר ימני גוניון.

תכונה

סוג הזיהוי של Google Cloud Vision API שרוצים לבצע, והמספר המקסימלי של התוצאות שרוצים לקבל עבור הסוג הזה. אפשר לציין כמה אובייקטים של Feature ברשימה של features.

שדות
type

Type

סוג התכונה.

max_results

int32

המספר המקסימלי של תוצאות מהסוג הזה. לא רלוונטי ל-TEXT_DETECTION, ל-DOCUMENT_TEXT_DETECTION או ל-CROP_HINTS.

model

string

המודל שבו צריך להשתמש בשביל התכונה. הערכים הנתמכים: builtin/stable (ברירת המחדל אם לא הוגדר ערך) ו-builtin/latest.

סוג

סוג התכונה של Google Cloud Vision API שרוצים לחלץ.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג התכונה לא צוין.
FACE_DETECTION הפעלת זיהוי פנים.
LANDMARK_DETECTION הפעלת זיהוי של ציוני דרך.
LOGO_DETECTION הפעלת זיהוי לוגו.
LABEL_DETECTION הפעלת זיהוי תוויות.
TEXT_DETECTION מריצים זיהוי טקסט או זיהוי תווים אופטי (OCR). זיהוי הטקסט מותאם לאזורים של טקסט בתוך תמונה גדולה יותר. אם התמונה היא מסמך, צריך להשתמש במקום זאת באפשרות DOCUMENT_TEXT_DETECTION.
DOCUMENT_TEXT_DETECTION מריצים OCR על מסמך עם טקסט צפוף. מקבל עדיפות אם מופיעים גם DOCUMENT_TEXT_DETECTION וגם TEXT_DETECTION.
SAFE_SEARCH_DETECTION מריצים חיפוש בטוח כדי לזהות תוכן שעלול להיות לא בטוח או לא רצוי.
IMAGE_PROPERTIES חישוב של קבוצת מאפייני תמונה, כמו הצבעים הדומיננטיים בתמונה.
CROP_HINTS מריצים הצעות חיתוך.
WEB_DETECTION מריצים זיהוי באינטרנט.
OBJECT_LOCALIZATION הפעלת לוקליזציה לזיהוי אובייקטים.

GcsDestination

המיקום ב-Google Cloud Storage שבו הפלט ייכתב.

שדות
uri

string

התוספת לשם של מאפיין ב-URI של Cloud Storage שבו יאוחסנו התוצאות. התוצאות יהיו בפורמט JSON, ולפניהן יופיע הקידומת של ה-URI של הקלט התואם. השדה הזה יכול לייצג קידומת של קובץ ב-Google Cloud Storage או ספרייה ב-Google Cloud Storage. בכל מקרה, ה-URI צריך להיות ייחודי, כי כדי לקבל את כל קובצי הפלט, תצטרכו לבצע חיפוש ב-Google Cloud Storage עם התו הכללי בקידומת ה-URI שסיפקתם.

דוגמאות:

אם יש כמה פלטים, כל תגובה היא עדיין AnnotateFileResponse, וכל אחת מהן מכילה קבוצת משנה של הרשימה המלאה של AnnotateImageResponse. יכול להיות שיהיו כמה פלטים, למשל אם קובץ ה-JSON של הפלט גדול מדי והוא מתפצל לכמה קבצים.

GcsSource

המיקום ב-Google Cloud Storage שממנו יתבצע קריאת הקלט.

שדות
uri

string

‫URI של Cloud Storage של קובץ הקלט. הערך הזה חייב להיות אובייקט ב-Google Cloud Storage. אין כרגע תמיכה בתווים כלליים לחיפוש.

GetProductRequest

הודעת בקשה לשיטה GetProduct.

שדות
name

string

חובה. שם המשאב של המוצר שרוצים לאחזר.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

GetProductSetRequest

הודעת בקשה לשיטה GetProductSet.

שדות
name

string

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

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID

GetReferenceImageRequest

הודעת בקשה לשיטה GetReferenceImage.

שדות
name

string

חובה. שם המשאב של ReferenceImage שרוצים לאחזר.

הפורמט הוא:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

תמונה

תמונה של לקוח לביצוע משימות של Google Cloud Vision API.

שדות
content

bytes

תוכן של תמונה, שמיוצג כזרם של בייטים. הערה: כמו בכל השדות של bytes, ב-Protobuf נעשה שימוש בייצוג בינארי טהור, ואילו בייצוגי JSON נעשה שימוש ב-Base64.

source

ImageSource

מיקום התמונה ב-Google Cloud Storage או כתובת URL של תמונה שנגישה לציבור. אם גם content וגם source מצוינים עבור תמונה, content מקבל עדיפות ומשמש לביצוע בקשת הערות התמונה.

ImageAnnotationContext

אם התמונה נוצרה מקובץ (למשל PDF), בהודעה הזו מופיע מידע על המקור של התמונה.

שדות
uri

string

ה-URI של הקובץ ששימש ליצירת התמונה.

page_number

int32

אם הקובץ היה PDF או TIFF, בשדה הזה מצוין מספר הדף בקובץ ששימש ליצירת התמונה.

ImageContext

הקשר של התמונה או פרמטרים ספציפיים לתכונה.

שדות
lat_long_rect

LatLongRect

לא בשימוש.

language_hints[]

string

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

crop_hints_params

CropHintsParams

פרמטרים לבקשת הערות לגבי הצעות לחיתוך.

product_search_params

ProductSearchParams

פרמטרים לחיפוש מוצרים.

web_detection_params

WebDetectionParams

פרמטרים לזיהוי באינטרנט.

ImageProperties

מאחסן מאפייני תמונה, כמו הצבעים הדומיננטיים.

שדות
dominant_colors

DominantColorsAnnotation

אם יש צבעים דומיננטיים, הם הושלמו.

ImageSource

מקור חיצוני של תמונה (Google Cloud Storage או כתובת URL של תמונה באינטרנט).

שדות
gcs_image_uri

string

במקום זאת, צריך להשתמש ב-image_uri.

‫URI של Cloud Storage מהצורה gs://bucket_name/object_name. אין תמיכה בניהול גרסאות של אובייקטים. מידע נוסף זמין במאמר בנושא כתובות URI של בקשות ב-Google Cloud Storage.
image_uri

string

ה-URI של תמונת המקור. יכול להיות:

  1. ‫URI של Cloud Storage בפורמט gs://bucket_name/object_name. אין תמיכה בניהול גרסאות של אובייקטים. מידע נוסף זמין במאמר בנושא Google Cloud Storage Request URIs.

  2. כתובת URL מסוג HTTP או HTTPS של תמונה שזמינה לציבור. כשמאחזרים תמונות מכתובות URL של HTTP/HTTPS, ‏ Google לא יכולה להבטיח שהבקשה תושלם. יכול להיות שהבקשה תיכשל אם המארח שצוין דוחה את הבקשה (למשל, בגלל הגבלת קצב הבקשות או מניעת התקפות מניעת שירות), או אם Google מגבילה את קצב הבקשות לאתר כדי למנוע ניצול לרעה. לא כדאי להסתמך על תמונות שמתארחות במקור חיצוני באפליקציות לייצור.

אם מציינים גם את gcs_image_uri וגם את image_uri, הערך של image_uri מקבל עדיפות.

ImportProductSetsGcsSource

המיקום ב-Google Cloud Storage של קובץ CSV שבו נשמרת רשימה של בקשות ImportProductSetRequest בכל שורה.

שדות
csv_file_uri

string

‫URI של Cloud Storage של קובץ ה-CSV של הקלט.

כתובת ה-URI חייבת להתחיל ב-gs://.

פורמט קובץ ה-CSV של הקלט צריך להיות תמונה אחת בכל שורה. בכל שורה יש 8 עמודות.

  1. image-uri
  2. image-id
  3. product-set-id
  4. product-id
  5. product-category
  6. product-display-name
  7. labels
  8. bounding-poly

העמודות image-uri, product-set-id, product-id ו-product-category הן חובה. כל שאר העמודות הן אופציונליות.

אם ProductSet או Product שצוינו בערכים product-set-id ו-product-id לא קיימים, המערכת תיצור ProductSet או Product חדשים לתמונה. במקרה הזה, העמודה product-display-name מפנה לעמודה display_name, העמודה product-category מפנה לעמודה product_category והעמודה labels מפנה לעמודה product_labels.

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

העמודה product-display-name היא אופציונלית. אם השדה ריק, המערכת מגדירה את השדה display_name של המוצר לרווח (" "). אפשר לעדכן את השדה display_name מאוחר יותר באמצעות ה-API.

אם כבר קיים Product עם product-id שצוין, המערכת מתעלמת מהעמודות product-display-name, product-category ו-labels.

העמודה labels (אופציונלי) היא שורה שמכילה רשימה של צמדי מפתח-ערך מופרדים בפסיקים, בפורמט הבא:

"key_1=value_1,key_2=value_2,...,key_n=value_n"

בעמודה bounding-poly (אופציונלי) מציינים אזור אחד שמעניין בתמונה, באותו אופן כמו בעמודה CreateReferenceImage. אם לא תציינו את העמודה bounding-poly, המערכת תנסה לזהות באופן אוטומטי אזורים שמעניינים אתכם.

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

העמודה bounding-poly צריכה להכיל מספר זוגי של מספרים מופרדים בפסיקים, בפורמט 'p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y'. משתמשים במספרים שלמים לא שליליים עבור מצולעים מוחלטים לתיחום, ובערכים מסוג float בטווח [0, 1] עבור מצולעים מנורמלים לתיחום.

המערכת תשנה את גודל התמונה אם הרזולוציה שלה גדולה מדי לעיבוד (גדולה מ-20MP).

ImportProductSetsInputConfig

תוכן הקלט של השיטה ImportProductSets.

שדות
gcs_source

ImportProductSetsGcsSource

המיקום ב-Google Cloud Storage של קובץ CSV שבו נשמרת רשימה של בקשות ImportProductSetRequest בכל שורה.

ImportProductSetsRequest

הודעת בקשה לשיטה ImportProductSets.

שדות
parent

string

חובה. הפרויקט שאליו רוצים לייבא את קבוצות המוצרים.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID.
input_config

ImportProductSetsInputConfig

חובה. תוכן הקלט לרשימת הבקשות.

ImportProductSetsResponse

הודעת התגובה לשיטה ImportProductSets.

ההודעה הזו מוחזרת על ידי השיטה google.longrunning.Operations.GetOperation בשדה google.longrunning.Operation.response שמוחזר.

שדות
reference_images[]

ReferenceImage

רשימת התמונות של המוצרים שהייבוא שלהן הצליח.

statuses[]

Status

סטטוס ה-RPC של כל בקשת ImportProductSet, כולל הצלחות ושגיאות.

מספר הסטטוסים שמוצג כאן תואם למספר השורות בקובץ ה-CSV, וב-statuses[i] מאוחסן סטטוס ההצלחה או הכשל של עיבוד השורה ה-i בקובץ ה-CSV, החל משורה 0.

InputConfig

מיקום הקלט הרצוי והמטא-נתונים.

שדות
gcs_source

GcsSource

המיקום ב-Google Cloud Storage שממנו יתבצע קריאת הקלט.

content

bytes

תוכן הקובץ, שמוצג כזרם של בייטים. הערה: כמו בכל השדות של bytes, ב-Protobuf נעשה שימוש בייצוג בינארי טהור, ואילו בייצוגי JSON נעשה שימוש ב-Base64.

בשלב הזה, השדה הזה פועל רק בבקשות BatchAnnotateFiles. היא לא פועלת בבקשות AsyncBatchAnnotateFiles.
mime_type

string

סוג הקובץ. בשלב הזה, יש תמיכה רק בערכים application/pdf,‏ image/tiff ו-image/gif. אין תמיכה בתווים כלליים לחיפוש.

LatLongRect

מלבן שנקבע על ידי זוגות של ערכים מינימליים ומקסימליים LatLng.

שדות
min_lat_lng

LatLng

זוג קווי הרוחב והאורך המינימליים.

max_lat_lng

LatLng

זוג קווי אורך ורוחב מקסימליים.

סבירות

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

טיפוסים בני מנייה (enum)
UNKNOWN סבירות לא ידועה.
VERY_UNLIKELY הסיכוי לכך נמוך מאוד.
UNLIKELY סביר להניח שלא.
POSSIBLE זה אפשרי.
LIKELY סביר להניח.
VERY_LIKELY סביר מאוד.

ListProductSetsRequest

הודעת בקשה לשיטה ListProductSets.

שדות
parent

string

חובה. הפרויקט שממנו צריך להציג את ProductSets.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID.
page_size

int32

מספר הפריטים המקסימלי שיוחזרו. ברירת המחדל היא 10, והערך המקסימלי הוא 100.

page_token

string

הטוקן של הדף הבא שהוחזר מבקשת List קודמת, אם יש כזה.

ListProductSetsResponse

הודעת התגובה לשיטה ListProductSets.

שדות
product_sets[]

ProductSet

רשימה של ProductSets.

next_page_token

string

אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין עוד תוצאות ברשימה.

ListProductsInProductSetRequest

הודעת בקשה לשיטה ListProductsInProductSet.

שדות
name

string

חובה. משאב ProductSet שממנו רוצים לאחזר מוצרים.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
page_size

int32

מספר הפריטים המקסימלי שיוחזרו. ברירת המחדל היא 10, והערך המקסימלי הוא 100.

page_token

string

הטוקן של הדף הבא שהוחזר מבקשת List קודמת, אם יש כזה.

ListProductsInProductSetResponse

הודעת התגובה לשיטה ListProductsInProductSet.

שדות
products[]

Product

רשימת המוצרים.

next_page_token

string

אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין עוד תוצאות ברשימה.

ListProductsRequest

הודעת בקשה לשיטה ListProducts.

שדות
parent

string

חובה. הפרויקט או ProductSet שממנו צריך להציג את המוצרים.

פורמט: projects/PROJECT_ID/locations/LOC_ID
page_size

int32

מספר הפריטים המקסימלי שיוחזרו. ברירת המחדל היא 10, והערך המקסימלי הוא 100.

page_token

string

הטוקן של הדף הבא שהוחזר מבקשת List קודמת, אם יש כזה.

ListProductsResponse

הודעת התגובה לשיטה ListProducts.

שדות
products[]

Product

רשימת מוצרים.

next_page_token

string

אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין עוד תוצאות ברשימה.

ListReferenceImagesRequest

הודעת בקשה לשיטה ListReferenceImages.

שדות
parent

string

חובה. שם המשאב של המוצר שמכיל את תמונות ההפניה.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
page_size

int32

מספר הפריטים המקסימלי שיוחזרו. ברירת המחדל היא 10, והערך המקסימלי הוא 100.

page_token

string

אסימון שמזהה איזה דף תוצאות להציג. זהו הערך של nextPageToken שמוחזר בבקשה קודמת של רשימת תמונות להשוואה.

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

ListReferenceImagesResponse

הודעת התגובה לשיטה ListReferenceImages.

שדות
reference_images[]

ReferenceImage

רשימת התמונות לדוגמה.

page_size

int32

מספר הפריטים המקסימלי שיוחזרו. ברירת המחדל היא 10, והערך המקסימלי הוא 100.

next_page_token

string

הטוקן של הדף הבא שהוחזר מבקשת List קודמת, אם יש כזה.

LocalizedObjectAnnotation

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

שדות
mid

string

מזהה האובייקט שצריך להיות זהה ל-mid של EntityAnnotation.

language_code

string

קוד השפה בפורמט BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name

string

שם האובייקט, בשפה language_code.

score

float

הניקוד של התוצאה. טווח [0, 1].

bounding_poly

BoundingPoly

האזור בתמונה שאליו שייך האובייקט הזה. חובה למלא את השדה הזה.

LocationInfo

פרטי המיקום של הישות שאותרה.

שדות
lat_lng

LatLng

קואורדינטות של קו הרוחב וקו האורך של המיקום.

NormalizedVertex

קודקוד מייצג נקודה דו-ממדית בתמונה. הערה: קואורדינטות הקודקודים המנורמלות הן יחסיות לתמונה המקורית, והערכים שלהן נעים בין 0 ל-1.

שדות
x

float

קואורדינטה X.

y

float

קואורדינטת Y.

OperationMetadata

מכיל מטא-נתונים של הפעולה BatchAnnotateImages.

שדות
state

State

המצב הנוכחי של הפעולה בקבוצה.

create_time

Timestamp

השעה שבה התקבלה בקשת Batch.

update_time

Timestamp

השעה שבה תוצאת הפעולה עודכנה לאחרונה.

מדינה

מצבי פעולות באצווה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED יש שגיאה.
CREATED הבקשה מתקבלת.
RUNNING הבקשה נמצאת בעיבוד.
DONE העיבוד באצווה הסתיים.
CANCELLED עיבוד האצווה בוטל.

OutputConfig

מיקום הפלט הרצוי והמטא-נתונים.

שדות
gcs_destination

GcsDestination

המיקום ב-Google Cloud Storage שבו ייכתבו הפלט או הפלטים.

batch_size

int32

המספר המקסימלי של פרוטוקולי תגובה שיוכנסו לכל קובץ JSON של פלט ב-Google Cloud Storage. הטווח התקין הוא [1, 100]. אם לא מציינים ערך, ערך ברירת המחדל הוא 20.

לדוגמה, עבור קובץ PDF אחד עם 100 דפים, ייווצרו 100 פרוטוקולים של תגובות. אם batch_size = 20, ייכתבו 5 קובצי JSON, כל אחד מהם מכיל 20 פרוטוקולי תגובה, עם הקידומת gcs_destination.uri.

בשלב הזה, batch_size רלוונטי רק ל-GcsDestination, אבל יכול להיות שבעתיד תהיה תמיכה גם בהגדרות פלט אחרות.

דף

דף שזוהה מ-OCR.

שדות
property

TextProperty

זוהה מידע נוסף בדף.

width

int32

רוחב הדף. ב-PDF, היחידה היא נקודות. בתמונות (כולל TIFF), היחידה היא פיקסלים.

height

int32

גובה הדף. ב-PDF, היחידה היא נקודות. בתמונות (כולל TIFF), היחידה היא פיקסלים.

blocks[]

Block

רשימה של בלוקים של טקסט, תמונות וכו' בדף הזה.

confidence

float

רמת הביטחון של תוצאות ה-OCR בדף. טווח [0, 1].

פסקה

יחידה מבנית של טקסט שמייצגת מספר מילים בסדר מסוים.

שדות
property

TextProperty

זוהה מידע נוסף לגבי הפסקה.

bounding_box

BoundingPoly

התיבה התוחמת של הפסקה. הקודקודים מסודרים לפי הסדר הבא: שמאל למעלה, ימין למעלה, ימין למטה, שמאל למטה. כשמזוהה סיבוב של תיבת התוחמת, הסיבוב מוצג סביב הפינה הימנית העליונה, כפי שמוגדר כשקוראים את הטקסט בכיוון 'הטבעי'. לדוגמה: * כשהטקסט אופקי, הוא יכול להיראות כך: 0----1 | | 3----2 * כשהוא מסובב ב-180 מעלות סביב הפינה הימנית העליונה, הוא נראה כך: 2----3 | | 1----0 וסדר הקודקודים עדיין יהיה (0, 1, 2, 3).

words[]

Word

רשימה של כל המילים בפסקה הזו.

confidence

float

רמת הוודאות של תוצאות ה-OCR בפסקה. טווח [0, 1].

מקום

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

שדות
x

float

קואורדינטה X.

y

float

קואורדינטת Y.

z

float

קואורדינטה Z (או עומק).

מוצר

מוצר מכיל ReferenceImages.

שדות
name

string

שם המשאב של המוצר.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

המערכת מתעלמת מהשדה הזה כשיוצרים מוצר.
display_name

string

השם שהמשתמש סיפק למוצר הזה. השדה לא יכול להיות ריק. האורך המקסימלי הוא 4,096 תווים.

description

string

מטא-נתונים שהמשתמש סיפק ויועברו לאחסון עם המוצר הזה. האורך המקסימלי הוא 4,096 תווים.

product_category

string

אי אפשר לשנות. הקטגוריה של המוצר שזוהה בתמונה לדוגמה. הערך צריך להיות homegoods-v2,‏ apparel-v2 או toys-v2. עדיין יש תמיכה בקטגוריות הקודמות homegoods [מוצרים_לבית], apparel [ביגוד] ו-toys [צעצועים], אבל לא מומלץ להשתמש בהן למוצרים חדשים.

product_labels[]

KeyValue

צמדי מפתח/ערך שאפשר לצרף למוצר. בזמן השאילתה, אפשר לציין אילוצים על סמך תוויות המוצרים.

שימו לב שאפשר לציין ערכים של מספרים שלמים כמחרוזות, למשל '1199'. רק מחרוזות עם ערכים שלמים יכולות להתאים להגבלה מבוססת-טווח, שתושק בקרוב.

אפשר להקצות כמה ערכים לאותו מפתח. לכל מוצר יכולות להיות עד 500 תוויות מוצר.

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

KeyValue

תווית מוצר שמיוצגת כצמד מפתח/ערך.

שדות
key

string

המפתח של התווית שמצורפת למוצר. השדה לא יכול להיות ריק והאורך שלו לא יכול לחרוג מ-128 בייט.

value

string

הערך של התווית שמצורפת למוצר. השדה לא יכול להיות ריק והאורך שלו לא יכול לחרוג מ-128 בייט.

ProductSearchParams

פרמטרים של בקשה לחיפוש מוצרים.

שדות
bounding_poly

BoundingPoly

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

product_set

string

שם המשאב של ProductSet שרוצים לחפש תמונות דומות לו.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.
product_categories[]

string

רשימת קטגוריות המוצרים שבהן יתבצע החיפוש. בשלב הזה, המערכת מתחשבת רק בקטגוריה הראשונה, וצריך לציין את אחת מהקטגוריות הבאות: homegoods-v2,‏ apparel-v2,‏ toys-v2,‏ packagedgoods-v1 או general-v1. הקטגוריות הקודמות 'מוצרים לבית', 'ביגוד' ו'צעצועים' עדיין נתמכות, אבל הן יוצאו משימוש. למוצרים חדשים, מומלץ להשתמש בערכים homegoods-v2,‏ apparel-v2 או toys-v2 כדי לשפר את הדיוק של חיפוש המוצרים. מומלץ להעביר גם מוצרים קיימים לקטגוריות האלה.

filter

string

ביטוי הסינון. אפשר להשתמש בזה כדי להגביל את תוצאות החיפוש על סמך תוויות מוצרים. בשלב הזה אנחנו תומכים בביטויים של מפתח/ערך עם AND או OR, כאשר לכל ביטוי בתוך OR חייב להיות אותו מפתח. צריך להשתמש בסימן '=' כדי לחבר בין המפתח לערך.

לדוגמה, המחרוזת (color = red OR color = blue) AND brand = Google היא קבילה, אבל המחרוזת (color = red OR brand = Google) לא קבילה. הערך color: red לא קביל כי נעשה בו שימוש ב-':' במקום ב-'='.

ProductSearchResults

תוצאות של בקשת חיפוש מוצר.

שדות
index_time

Timestamp

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

results[]

Result

רשימת תוצאות, אחת לכל התאמה של מוצר.

product_grouped_results[]

GroupedResult

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

GroupedResult

מידע על מוצרים שדומים למוצר בודד בתמונה של שאילתה.

שדות
bounding_poly

BoundingPoly

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

results[]

Result

רשימת תוצאות, אחת לכל התאמה של מוצר.

object_annotations[]

ObjectAnnotation

רשימה של תחזיות כלליות לגבי האובייקט בתיבת התוחמת.

ObjectAnnotation

תחזית לגבי האובייקט בתיבת התוחמת.

שדות
mid

string

מזהה האובייקט שצריך להיות זהה ל-mid של EntityAnnotation.

language_code

string

קוד השפה בפורמט BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

name

string

שם האובייקט, בשפה language_code.

score

float

הניקוד של התוצאה. טווח [0, 1].

תוצאה

מידע על מוצר.

שדות
product

Product

המוצר.

score

float

רמת המהימנות של ההתאמה, בין 0 (ללא מהימנות) ל-1 (מהימנות מלאה).

image

string

שם המשאב של התמונה מהמוצר שהכי מתאים לשאילתה.

ProductSet

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

שדות
name

string

שם המשאב של ProductSet.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

המערכת מתעלמת מהשדה הזה כשיוצרים ProductSet.
display_name

string

השם שסופק על ידי המשתמש לקבוצת המוצרים הזו. השדה לא יכול להיות ריק. האורך המקסימלי הוא 4,096 תווים.

index_time

Timestamp

פלט בלבד. השעה שבה קבוצת המוצרים הזו נוספה לאינדקס בפעם האחרונה. תוצאות השאילתות ישקפו את כל העדכונים שבוצעו לפני הזמן הזה. אם אף פעם לא בוצע אינדוקס של קבוצת המוצרים הזו, חותמת הזמן הזו היא ערך ברירת המחדל '1970-01-01T00:00:00Z'.

המערכת מתעלמת מהשדה הזה כשיוצרים ProductSet.
index_error

Status

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

המערכת מתעלמת מהשדה הזה כשיוצרים ProductSet.

ProductSetPurgeConfig

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

שדות
product_set_id

string

האוסף ProductSet שמכיל את המוצרים שרוצים למחוק. אם מוצר משויך למזהה קבוצת מוצרים [product_set_id] בנוסף לקבוצות מוצרים אחרות, הוא עדיין יימחק.

מאפיין (property)

Property מורכב מצמד של שם/ערך שסופק על ידי המשתמש.

שדות
name

string

שם הנכס.

value

string

הערך של המאפיין.

uint64_value

uint64

הערך של מאפיינים מספריים.

PurgeProductsRequest

הודעת בקשה לשיטה PurgeProducts.

שדות
parent

string

חובה. הפרויקט והמיקום שבהם צריך למחוק את המוצרים.

הפורמט הוא projects/PROJECT_ID/locations/LOC_ID.
force

bool

ערך ברירת המחדל הוא false. כדי לבצע את ההסרה בפועל, צריך לשנות את הערך הזה ל-true.

שדה איחוד target. המוצרים למחיקה. הערך target יכול להיות רק אחד מהבאים:
product_set_purge_config

ProductSetPurgeConfig

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

delete_orphan_products

bool

אם הערך של delete_orphan_products הוא true, כל המוצרים שלא נמצאים באף ProductSet יימחקו.

ReferenceImage

ReferenceImage מייצג תמונה של מוצר ואת המטא-נתונים שמשויכים אליה, כמו תיבות תוחמות.

שדות
name

string

שם המשאב של תמונה לדוגמה.

הפורמט הוא:

projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID.

המערכת מתעלמת מהשדה הזה כשיוצרים תמונה לדוגמה.
uri

string

חובה. ‫URI של Cloud Storage של תמונה לדוגמה.

כתובת ה-URI חייבת להתחיל ב-gs://.
bounding_polys[]

BoundingPoly

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

הצורה שצוינה מומרת למלבן לא מסובב. אחרי ההמרה, הצד הקצר של המלבן צריך להיות באורך של 300 פיקסלים לפחות. יחס הגובה-רוחב צריך להיות 1:4 או פחות (כלומר, 1:3 תקין, 1:5 לא תקין).

RemoveProductFromProductSetRequest

הודעת בקשה לשיטה RemoveProductFromProductSet.

שדות
name

string

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

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
product

string

חובה. שם המשאב של המוצר שצריך להסיר מ-ProductSet הזה.

הפורמט הוא: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID

SafeSearchAnnotation

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

שדות
adult

Likelihood

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

spoof

Likelihood

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

medical

Likelihood

הסבירות שמדובר בתמונה רפואית.

violence

Likelihood

הסבירות שהתמונה הזו מכילה תוכן אלים.

racy

Likelihood

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

סמל

ייצוג של סמל יחיד.

שדות
property

TextProperty

זוהה מידע נוסף לגבי הסמל.

bounding_box

BoundingPoly

התיבה התוחמת של הסמל. הקודקודים מסודרים לפי הסדר הבא: שמאל למעלה, ימין למעלה, ימין למטה, שמאל למטה. כשמזוהה סיבוב של תיבת התוחמת, הסיבוב מוצג סביב הפינה הימנית העליונה, כפי שמוגדר כשקוראים את הטקסט בכיוון 'הטבעי'. לדוגמה: * כשהטקסט אופקי, הוא יכול להיראות כך: 0----1 | | 3----2 * כשהוא מסובב ב-180 מעלות סביב הפינה הימנית העליונה, הוא נראה כך: 2----3 | | 1----0 וסדר הקודקודים עדיין יהיה (0, 1, 2, 3).

text

string

הייצוג בפועל של הסמל ב-UTF-8.

confidence

float

רמת המהימנות של תוצאות ה-OCR של הסמל. טווח [0, 1].

TextAnnotation

‫TextAnnotation מכיל ייצוג מובנה של טקסט שחולץ באמצעות OCR. ההיררכיה של מבנה טקסט שחולץ באמצעות OCR היא כזו: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol לכל רכיב מבני, החל מ-Page, יכולות להיות מאפיינים משלו. המאפיינים מתארים את השפות שזוהו, את ההפסקות וכו'. הסבר מפורט מופיע בהמשך, בקטע TextAnnotation.TextPropertyהגדרת ההודעה.

שדות
pages[]

Page

רשימת הדפים שזוהו על ידי ה-OCR.

text

string

זוהה טקסט בפורמט UTF-8 בדפים.

DetectedBreak

זוהתה התחלה או סיום של רכיב מבני.

שדות
type

BreakType

סוג המעבר שזוהה.

is_prefix

bool

הערך הוא True אם התג break מופיע לפני הרכיב.

BreakType

טיפוסים בני מנייה (enum) לציון סוג ההפסקה שנמצאה. שורה חדשה, רווח וכו'.

טיפוסים בני מנייה (enum)
UNKNOWN סוג התווית של ההפסקה לא ידוע.
SPACE מרחב רגיל.
SURE_SPACE מרחב בטוח (רחב מאוד).
EOL_SURE_SPACE מעבר שורה.
HYPHEN מקף בסוף השורה שלא מופיע בטקסט; לא מופיע יחד עם SPACE,‏ LEADER_SPACE או LINE_BREAK.
LINE_BREAK מעבר שורה שמסיים פסקה.

DetectedLanguage

השפה שזוהתה עבור רכיב מבני.

שדות
language_code

string

קוד השפה בפורמט BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence

float

רמת הביטחון לגבי השפה שזוהתה. טווח [0, 1].

TextProperty

זוהה מידע נוסף ברכיב המבני.

שדות
detected_languages[]

DetectedLanguage

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

detected_break

DetectedBreak

זוהתה התחלה או סיום של פלח טקסט.

UpdateProductRequest

הודעת בקשה לשיטה UpdateProduct.

שדות
product

Product

חובה. משאב המוצר שמחליף את המוצר בשרת. אי אפשר לשנות את הערך של product.name.

update_mask

FieldMask

השדה FieldMask שמציין אילו שדות לעדכן. אם לא מציינים את update_mask, כל השדות שניתנים לשינוי יעודכנו. נתיבי מסכה תקינים כוללים את product_labels, display_name וdescription.

UpdateProductSetRequest

הודעת בקשה לשיטה UpdateProductSet.

שדות
product_set

ProductSet

חובה. משאב ProductSet שמחליף את המשאב בשרת.

update_mask

FieldMask

השדה FieldMask שמציין אילו שדות לעדכן. אם לא מציינים את update_mask, כל השדות שניתנים לשינוי יעודכנו. נתיב המסכה התקין הוא display_name.

קודקודים

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

שדות
x

int32

קואורדינטה X.

y

int32

קואורדינטת Y.

WebDetection

מידע רלוונטי לתמונה מהאינטרנט.

שדות
web_entities[]

WebEntity

ישות שהוסקה מתמונות דומות באינטרנט.

full_matching_images[]

WebImage

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

partial_matching_images[]

WebImage

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

pages_with_matching_images[]

WebPage

דפי אינטרנט שמכילים את התמונות התואמות מהאינטרנט.

visually_similar_images[]

WebImage

תוצאות של תמונות דומות מבחינה חזותית.

best_guess_labels[]

WebLabel

הניחוש הכי טוב של השירות לגבי הנושא של התמונה שמופיעה בבקשה. המידע הזה נגזר מתמונות דומות באינטרנט הפתוח.

WebEntity

הישות נגזרת מתמונות דומות באינטרנט.

שדות
entity_id

string

מזהה ישות אטום.

score

float

ציון הרלוונטיות הכולל של הישות. לא מנורמלים ולא ניתנים להשוואה בין שאילתות שונות של תמונות.

description

string

תיאור קנוני של הישות, באנגלית.

WebImage

מטא-נתונים של תמונות באינטרנט.

שדות
url

string

כתובת ה-URL של תמונת התוצאה.

score

float

(הוצא משימוש) ציון הרלוונטיות הכולל של התמונה.

WebLabel

תווית שמספקת מטא-נתונים נוספים לזיהוי באינטרנט.

שדות
label

string

תווית למטא-נתונים נוספים.

language_code

string

קוד השפה בפורמט BCP-47 עבור label, למשל 'en-US' או 'sr-Latn'. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

WebPage

מטא-נתונים של דפי אינטרנט.

שדות
url

string

כתובת ה-URL של דף האינטרנט של התוצאה.

score

float

(הוצא משימוש) ציון הרלוונטיות הכולל של דף האינטרנט.

page_title

string

הכותרת של דף האינטרנט, יכולה להכיל תגי עיצוב של HTML.

full_matching_images[]

WebImage

תמונות זהות בדף. יכול לכלול עותקים של תמונת השאילתה שגודלם שונה.

partial_matching_images[]

WebImage

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

WebDetectionParams

פרמטרים של בקשה לזיהוי באינטרנט.

שדות
include_geo_results

bool

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

Word

ייצוג של מילה.

שדות
property

TextProperty

זוהה מידע נוסף לגבי המילה.

bounding_box

BoundingPoly

התיבה התוחמת (bounding box) של המילה. הקודקודים מסודרים לפי הסדר הבא: שמאל למעלה, ימין למעלה, ימין למטה, שמאל למטה. כשמזוהה סיבוב של תיבת התוחמת, הסיבוב מוצג סביב הפינה הימנית העליונה, כפי שמוגדר כשקוראים את הטקסט בכיוון 'הטבעי'. לדוגמה: * כשהטקסט אופקי, הוא יכול להיראות כך: 0----1 | | 3----2 * כשהוא מסובב ב-180 מעלות סביב הפינה הימנית העליונה, הוא נראה כך: 2----3 | | 1----0 וסדר הקודקודים עדיין יהיה (0, 1, 2, 3).

symbols[]

Symbol

רשימת הסמלים במילה. סדר הסמלים הוא לפי סדר הקריאה הטבעי.

confidence

float

רמת הביטחון של תוצאות ה-OCR למילה. טווח [0, 1].