Skip to main content

Package animeshon.vision.v1alpha1

Index

BoundingPoly

A bounding polygon for the detected image annotation.

FieldDescription
verticesrepeated Vertex
The bounding polygon vertices.

Vertex

A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.

FieldDescription
x int32
X coordinate.
y int32
Y coordinate.

EntityAnnotation

FieldDescription
name string
The entity resource name.
score float
Overall score of the result. Range [0, 1].
bounding_box BoundingPoly
Image region to which this entity belongs.

ImageAnnotations

FieldDescription
text_annotationsrepeated TextAnnotation
The texts detected in the image.
label_annotationsrepeated LabelAnnotation
The labels detected in the image.
entity_annotationsrepeated EntityAnnotation
The entites detected in the image.
knowledge_graph_annotationsrepeated KnowledgeGraphAnnotation
The Animeshon Graph Knowledge-Base resources detected in the image.
web_search_annotationsrepeated WebSearchAnnotation
The WebSearch resources (pages and images) detected in the image.
safe_search_annotation SafeSearchAnnotation
The SafeSearch ratings detected in the image.

KnowledgeGraphAnnotation

FieldDescription
resource string
The Animeshon Graph Knowledge-Base resource name.
score float
Overall score of the result. Range [0, 1].
bounding_box BoundingPoly
Image region to which this entity belongs.

LabelAnnotation

FieldDescription
name string
The label resource name.
score float
Overall score of the result. Range [0, 1].
topicality float
The relevancy of the annotation. Range [0, 1].

SafeSearchAnnotation

FieldDescription
adult Likelihood
Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.
racy Likelihood
Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.
violence Likelihood
Likelihood that this image contains violent content.
medical Likelihood
Likelihood that this is a medical image.
juvenile Likelihood
Likelihood that the request image contains one or more individuals decipted as juveniles. Juvenile content may contain elements such as school-aged children, preschoolers, toddlers, infants, and newborns. The target age considered as juvenile is from 0 to 14~16 years old.

TextAnnotation

FieldDescription
property TextAnnotation.TextProperty
Additional information detected for the paragraph.
bounding_box BoundingPoly
The bounding box for the paragraph.
text string
UTF-8 text detected by the OCR.
confidence float
Confidence of the OCR results for the paragraph. Range [0, 1].

TextAnnotation.Language

Detected language for a structural component.

FieldDescription
language_code string
The BCP-47 language code, such as "en-US" or "sr-Latn".
confidence float
Confidence of detected language. Range [0, 1].

TextAnnotation.TextProperty

Additional information detected on the structural component.

FieldDescription
languagesrepeated TextAnnotation.Language
A list of detected languages together with confidence.

WebSearchAnnotation

FieldDescription
url string
The result image URL.
score float
Overall relevancy score for the image.

Likelihood

A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.

NameDescription
UNKNOWNUnknown likelihood.
VERY_UNLIKELYIt is very unlikely.
UNLIKELYIt is unlikely.
POSSIBLEIt is possible.
LIKELYIt is likely.
VERY_LIKELYIt is very likely.

ColorProperty

Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.

FieldDescription
color google.type.Color
RGB components of the color.
score float
Image-specific score for this color. Value in range [0, 1].
pixel_fraction float
The fraction of pixels the color occupies in the image. Value in range [0, 1].

FingerprintProperty

FieldDescription
content bytes
The fingerprint of the image in binary representation.
algorithm string
The algorithm used to generate the fingerprint.

ImageProperties

FieldDescription
dominant_colorsrepeated ColorProperty
Set of dominant colors and their corresponding scores.
fingerprintsrepeated FingerprintProperty
The fingerprints of the image.

ImageAnnotator

AnalyzeImage
rpc AnalyzeImage(AnalyzeImageRequest) AnalyzeImageResponse

GetImageAnalysis
rpc GetImageAnalysis(GetImageAnalysisRequest) ImageAnalysis

Note: to fetch the latest available report use "latest" as report id.
ListImageAnalyses
rpc ListImageAnalyses(ListImageAnalysesRequest) ListImageAnalysesResponse

DeleteImageAnalysis
rpc DeleteImageAnalysis(DeleteImageAnalysisRequest) .google.protobuf.Empty

GetImageAnnotation
rpc GetImageAnnotation(GetImageAnnotationRequest) ImageAnnotation

ListImageAnnotations
rpc ListImageAnnotations(ListImageAnnotationsRequest) ListImageAnnotationsResponse

CreateImageAnnotation
rpc CreateImageAnnotation(CreateImageAnnotationRequest) ImageAnnotation

UpdateImageAnnotation
rpc UpdateImageAnnotation(UpdateImageAnnotationRequest) ImageAnnotation

DeleteImageAnnotation
rpc DeleteImageAnnotation(DeleteImageAnnotationRequest) .google.protobuf.Empty

AnalyzeImageRequest

FieldDescription
parent string
The parent image to be analyzed.
featuresrepeated string
A list of features to analyze.

AnalyzeImageResponse

FieldDescription
analysis ImageAnalysis
The analysis of the image.

CreateImageAnnotationRequest

FieldDescription
parent string
The parent this image annotation belongs to.
annotation ImageAnnotation
The image annotation to create.

DeleteImageAnalysisRequest

FieldDescription
name string
The name of the analysis to delete.

DeleteImageAnnotationRequest

FieldDescription
name string
The image annotation to delete.

GetImageAnalysisRequest

FieldDescription
name string
The name of the image analysis to retrieve.
field_mask google.protobuf.FieldMask
FieldMask that represents which fields should be retrieved.

GetImageAnnotationRequest

FieldDescription
name string
The name of the image annotation to retrieve.

ImageAnalysis

TODO: add information about the model used and whether the analysis is STABLE TODO: or EXPERIMENTAL. NOTE: Latest should return the latest STABLE analysis.

FieldDescription
name string
The name of the image analysis.
properties ImageProperties
The (immutable) properties of the image.
annotations ImageAnnotations
The annotations of the image.
create_time google.protobuf.Timestamp
The creation time indicating when this revision was created.

ImageAnnotation

FieldDescription
name string
The annotation resource name.
resource string
The annotated image.
annotations ImageAnnotations
The annotations of the image.
create_time google.protobuf.Timestamp
The timestamp at which the annotation was created.
update_time google.protobuf.Timestamp
The latest timestamp at which the annotation was updated.

ListImageAnalysesRequest

FieldDescription
parent string
The parent image to list analyses from.
page_size int32
If unspecified, server will pick an appropriate default.
page_token string
The value returned from the previous call.

ListImageAnalysesResponse

FieldDescription
analysesrepeated ImageAnalysis
The list of image analyses.
next_page_token string
A token to retrieve next page of results.

ListImageAnnotationsRequest

FieldDescription
parent string
The parent, which owns this collection of image annotations.
page_size int32
If unspecified, server will pick an appropriate default.
page_token string
The value returned from the previous call.
filter string
A filter to be applied to results.

Currently accepted filters include: - resource:{full resource name} |

ListImageAnnotationsResponse

FieldDescription
annotationsrepeated ImageAnnotation
The list of image annotations.
next_page_token string
A token to retrieve next page of results.

UpdateImageAnnotationRequest

FieldDescription
annotation ImageAnnotation
The image annotation to update.
update_mask google.protobuf.FieldMask
The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.