Class: Google::Cloud::Vision::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/vision/project.rb

Overview

# Project

Google Cloud Vision allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content.

See Google::Cloud#vision

Examples:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "path/to/landmark.jpg"

annotation = vision.annotate image, labels: true

annotation.labels.map &:description
#=> ["stone carving", "ancient history", "statue", "sculpture",
#=>  "monument", "landmark"]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service) ⇒ Project

Returns a new instance of Project.



56
57
58
 
# File 'lib/google/cloud/vision/project.rb', line 56

def initialize service
  @service = service
end

Instance Attribute Details

#service ⇒ Object 



52
53
54
 
# File 'lib/google/cloud/vision/project.rb', line 52

def service
  @service
end

Class Method Details

.default_project ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/google/cloud/vision/project.rb', line 78

def self.default_project
  ENV["VISION_PROJECT"] ||
    ENV["GOOGLE_CLOUD_PROJECT"] ||
    ENV["GCLOUD_PROJECT"] ||
    Google::Cloud::Core::Environment.project_id
end

Instance Method Details

#annotate(*images, faces: false, landmarks: false, logos: false, labels: false, text: false, safe_search: false, properties: false) {|annotate| ... } ⇒ Annotation+ Also known as: mark, detect

Performs detection of Cloud Vision [features](cloud.google.com/vision/reference/rest/v1/images/annotate#Feature) on the given image(s). If no options for features are provided, all image detection features will be performed, with a default of ‘100` results for faces, landmarks, logos, and labels. If any feature option is provided, only the specified feature detections will be performed. Please review [Pricing](cloud.google.com/vision/docs/pricing) before use, as a separate charge is incurred for each feature performed on an image.

Cloud Vision sets upper limits on file size as well as on the total combined size of all images in a request. Reducing your file size can significantly improve throughput; however, be careful not to reduce image quality in the process. See [Best Practices - Image Sizing](cloud.google.com/vision/docs/best-practices#image_sizing) for current file size limits.

Examples:

With a single image:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "path/to/landmark.jpg"

annotation = vision.annotate image, labels: true

annotation.labels.map &:description
#=> ["stone carving", "ancient history", "statue", "sculpture",
#=>  "monument", "landmark"]

With multiple images:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

face_img = vision.image "path/to/face.jpg"
landmark_img = vision.image "path/to/landmark.jpg"

annotations = vision.annotate face_img, landmark_img, labels: true

annotations[0].labels.count #=> 4
annotations[1].labels.count #=> 6

With multiple images and configurations passed in a block:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

face_img = vision.image "path/to/face.jpg"
landmark_img = vision.image "path/to/landmark.jpg"
text_image = vision.image "path/to/text.png"

annotations = vision.annotate do |annotate|
   annotate.annotate face_img, faces: true, labels: true
   annotate.annotate landmark_img, landmarks: true
   annotate.annotate text_image, text: true
end

annotations[0].faces.count #=> 1
annotations[0].labels.count #=> 4
annotations[1].landmarks.count #=> 1
annotations[2].text.words.count #=> 28

Maximum result values can also be provided:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "path/to/landmark.jpg"

annotation = vision.annotate image, labels: 3

annotation.labels.map &:description
#=> ["stone carving", "ancient history", "statue"]

Parameters:

  • images (Image, Object) —

    The image or images to annotate. This can be an Image instance, or any other type that converts to an Image. See #image for details.

  • faces (Boolean, Integer) (defaults to: false) —

    Whether to perform the facial detection feature. The maximum number of results is configured in Google::Cloud::Vision.default_max_faces, or may be provided here. Optional.

  • landmarks (Boolean, Integer) (defaults to: false) —

    Whether to perform the landmark detection feature. The maximum number of results is configured in Google::Cloud::Vision.default_max_landmarks, or may be provided here. Optional.

  • logos (Boolean, Integer) (defaults to: false) —

    Whether to perform the logo detection feature. The maximum number of results is configured in Google::Cloud::Vision.default_max_logos, or may be provided here. Optional.

  • labels (Boolean, Integer) (defaults to: false) —

    Whether to perform the label detection feature. The maximum number of results is configured in Google::Cloud::Vision.default_max_labels, or may be provided here. Optional.

  • text (Boolean) (defaults to: false) —

    Whether to perform the text (OCR) feature. Optional.

  • safe_search (Boolean) (defaults to: false) —

    Whether to perform the safe search feature. Optional.

  • properties (Boolean) (defaults to: false) —

    Whether to perform the image properties feature (currently, the image’s dominant colors.) Optional.

Yields:

Yield Parameters:

  • annotate (Annotate) —

    the Annotate object

Returns:

  • (Annotation, Array<Annotation>) —

    The results for all image detections, returned as a single Annotation instance for one image, or as an array of Annotation instances, one per image, for multiple images.

See Also:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/google/cloud/vision/project.rb', line 247

def annotate *images, faces: false, landmarks: false, logos: false,
             labels: false, text: false, safe_search: false,
             properties: false
  a = Annotate.new self
  a.annotate(*images, faces: faces, landmarks: landmarks, logos: logos,
                      labels: labels, text: text,
                      safe_search: safe_search, properties: properties)

  yield a if block_given?

  grpc = service.annotate a.requests
  annotations = Array(grpc.responses).map do |g|
    fail Error.from_error(g.error) if g.error
    Annotation.from_grpc g
  end
  return annotations.first if annotations.count == 1
  annotations
end

#image(source) ⇒ Image

Returns a new image from the given source.

Cloud Vision sets upper limits on file size as well as on the total combined size of all images in a request. Reducing your file size can significantly improve throughput; however, be careful not to reduce image quality in the process. See [Best Practices - Image Sizing](cloud.google.com/vision/docs/best-practices#image_sizing) for current file size limits.

Note that an object in Google Cloud Storage is a single entity; permissions affect only that object. “Directory permissions” do not exist (though default bucket permissions do exist). Make sure the code which performs your request has access to that image.

Examples:

With a Google Cloud Storage URI:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "gs://bucket-name/path_to_image_object"

With a local file path:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new

image = vision.image "path/to/landmark.jpg"

Parameters:

  • source (String, IO, StringIO, Tempfile, Google::Cloud::Storage::File) —

    A string file path or Cloud Storage URI of the form ‘“gs://bucketname/path/to/image_filename”`; or a File, IO, StringIO, or Tempfile instance; or an instance of Google::Cloud::Storage::File.

Returns:

  • (Image) —

    An image for the Vision service.

See Also:



125
126
127
128
 
# File 'lib/google/cloud/vision/project.rb', line 125

def image source
  return source if source.is_a? Image
  Image.from_source source, self
end

#project ⇒ Object

The Vision project connected to.

Examples:

require "google/cloud/vision"

vision = Google::Cloud::Vision.new(
  project: "my-todo-project",
  keyfile: "/path/to/keyfile.json"
)

vision.project #=> "my-todo-project"



72
73
74
 
# File 'lib/google/cloud/vision/project.rb', line 72

def project
  service.project
end