Package google.cloud.vision.v1

אינדקס

ImageAnnotator

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

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

AnnotateFileRequest

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

שדות
input_config

InputConfig

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

Feature

חובה. התכונות שביקשתם.
image_context

ImageContext

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

int32

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

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

הערך 1 מייצג את הדף הראשון. "דף 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

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

שדות
text_annotations[]

EntityAnnotation

אם הוא מופיע, זיהוי הטקסט (OCR) הסתיים בהצלחה.
full_text_annotation

TextAnnotation

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

Status

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

ImageAnnotationContext

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

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

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

חסימה

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

שדות
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

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

EntityAnnotation

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

שדות
mid

string

מזהה ישות אטום. יכול להיות שחלק מהמזהים יהיו זמינים ב-Knowledge Graph Search API של Google.
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.
properties[]

Property

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

תכונה

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

שדות
type

Type

סוג התכונה.
model

string

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

סוג

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

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

תמונה

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

שדות
content

bytes

תוכן התמונה, מיוצג כרצף של בייטים. הערה: כמו בכל השדות של bytes, מאגרי פרוטוקולים משתמשים בייצוג בינארי טהור, ואילו ייצוגי JSON משתמשים ב-base64.

נכון לעכשיו, השדה הזה פועל רק בבקשות BatchAnnotateImages. היא לא פועלת בבקשות AsyncBatchAnnotateImages.

ImageAnnotationContext

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

שדות
uri

string

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

int32

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

ImageContext

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

שדות
language_hints[]

string

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

TextDetectionParams

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

InputConfig

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

שדות
content

bytes

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

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

string

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

NormalizedVertex

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

שדות
x

float

קואורדינטת X.
y

float

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

דף

דף שזוהה באמצעות 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].

מאפיין (property)

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

שדות
name

string

שם הנכס.
value

string

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

uint64

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

סמל

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

שדות
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, יכולים להיות מאפיינים שמתארים שפות שזוהו, מעברים וכו'. פרטים נוספים זמינים בהגדרת ההודעה TextAnnotation.TextProperty שבהמשך.

שדות
pages[]

Page

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

string

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

DetectedBreak

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

שדות
type

BreakType

סוג ההפסקה שזוהה.
is_prefix

bool

‫True אם המעבר מופיע לפני הרכיב.

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". מידע נוסף זמין בכתובת https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
confidence

float

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

TextProperty

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

שדות
detected_languages[]

DetectedLanguage

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

DetectedBreak

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

TextDetectionParams

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

שדות
enable_text_detection_confidence_score

bool

כברירת מחדל, Cloud Vision API כולל רק את ציון רמת הסמך של התוצאה של DOCUMENT_TEXT_DETECTION. כדי לכלול גם את ציון רמת הסמך של TEXT_DETECTION, צריך להגדיר את הסימון כ-true.
advanced_ocr_options[]

string

רשימה של אפשרויות OCR מתקדמות להתאמה אישית של התנהגות ה-OCR.

Vertex

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

שדות
x

int32

קואורדינטת X.
y

int32

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

Word

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

שדות
property

TextProperty

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

BoundingPoly

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

Symbol

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

float

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