https://github.com/zquestz/pigeon
Google Cloud Vision API on Golang.
https://github.com/zquestz/pigeon
Last synced: 6 months ago
JSON representation
Google Cloud Vision API on Golang.
- Host: GitHub
- URL: https://github.com/zquestz/pigeon
- Owner: zquestz
- License: mit
- Fork: true (kaneshin/pigeon)
- Created: 2016-10-16T18:59:02.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-06T01:59:42.000Z (over 9 years ago)
- Last Synced: 2025-12-30T10:07:50.381Z (6 months ago)
- Language: Go
- Homepage: http://kaneshin.github.io/pigeon/
- Size: 1.62 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Pigeon - Google Cloud Vision API on Golang
`pigeon` is a service for the Google Cloud Vision API on Golang.
## Badges
[](https://godoc.org/github.com/zquestz/pigeon)
[](https://app.wercker.com/project/bykey/265bd30a85f806655926be3ded5eff13)
[](http://makeapullrequest.com)
[](https://codeclimate.com/github/zquestz/pigeon)
## Prerequisite
You need to export a service account json file to `GOOGLE_APPLICATION_CREDENTIALS` variable.
```
$ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json
```
## Installation
### `pigeon` and `pigeon-app` commands
`pigeon` provides the command-line tools.
```shell
$ go get github.com/zquestz/pigeon/tools/cmd/...
```
Make sure that `pigeon` was installed correctly:
```shell
$ pigeon -h
$ pigeon-app -h
```
### `pigeon` package
Type the following line to install `pigeon` package.
```shell
$ go get github.com/zquestz/pigeon
```
## Usage
### `pigeon` command
`pigeon` is available to submit request with external image source (i.e. Google Cloud Storage image location).
```shell
# Default Detection is LabelDetection.
$ pigeon assets/lenna.jpg
$ pigeon -face gs://bucket_name/lenna.jpg
$ pigeon -label https://httpbin.org/image/jpeg
```
### `pigeon-app` command
```shell
# Default port is 8080.
# Default Detection is LabelDetection.
$ pigeon-app
$ pigeon-app -port=8000 -- -face -label -safe-search
$ curl -XGET localhost:8080/
```
### `pigeon` package
```go
import "github.com/zquestz/pigeon"
import "github.com/zquestz/pigeon/credentials"
func main() {
// Initialize vision service by a credentials json.
creds := credentials.NewApplicationCredentials("credentials.json")
// creds will set a pointer of credentials object using env value of
// "GOOGLE_APPLICATION_CREDENTIALS" if pass empty string to argument.
// creds := credentials.NewApplicationCredentials("")
config := NewConfig().WithCredentials(creds)
client, err := pigeon.New(config)
if err != nil {
panic(err)
}
// To call multiple image annotation requests.
feature := pigeon.NewFeature(pigeon.LabelDetection)
batch, err := client.NewBatchAnnotateImageRequest([]string{"lenna.jpg"}, feature)
if err != nil {
panic(err)
}
// Execute the "vision.images.annotate".
res, err := client.ImagesService().Annotate(batch).Do()
if err != nil {
panic(err)
}
// Marshal annotations from responses
body, _ := json.MarshalIndent(res.Responses, "", " ")
fmt.Println(string(body))
}
```
#### pigeon.Client
The `pigeon.Client` is wrapper of the `vision.Service`.
```go
// Initialize vision client by a credentials json.
creds := credentials.NewApplicationCredentials("credentials.json")
client, err := pigeon.New(creds)
if err != nil {
panic(err)
}
```
#### vision.Feature
`vision.Feature` will be applied to `vision.AnnotateImageRequest`.
```go
// DetectionType returns a value of detection type.
func DetectionType(d int) string {
switch d {
case TypeUnspecified:
return "TYPE_UNSPECIFIED"
case FaceDetection:
return "FACE_DETECTION"
case LandmarkDetection:
return "LANDMARK_DETECTION"
case LogoDetection:
return "LOGO_DETECTION"
case LabelDetection:
return "LABEL_DETECTION"
case TextDetection:
return "TEXT_DETECTION"
case SafeSearchDetection:
return "SAFE_SEARCH_DETECTION"
case ImageProperties:
return "IMAGE_PROPERTIES"
}
return ""
}
// Choose detection types
features := []*vision.Feature{
pigeon.NewFeature(pigeon.FaceDetection),
pigeon.NewFeature(pigeon.LabelDetection),
pigeon.NewFeature(pigeon.ImageProperties),
}
```
#### vision.AnnotateImageRequest
`vision.AnnotateImageRequest` needs to set the uri of the form `"gs://bucket_name/foo.png"` or byte content of image.
- Google Cloud Storage
```go
src := "gs://bucket_name/lenna.jpg"
req, err := pigeon.NewAnnotateImageSourceRequest(src, features...)
if err != nil {
panic(err)
}
```
- Base64 Encoded String
```go
b, err := ioutil.ReadFile(filename)
if err != nil {
panic(err)
}
req, err = pigeon.NewAnnotateImageContentRequest(b, features...)
if err != nil {
panic(err)
}
```
#### Submit the request to the Google Cloud Vision API
```go
// To call multiple image annotation requests.
batch, err := client.NewBatchAnnotateImageRequest(list, features()...)
if err != nil {
panic(err)
}
// Execute the "vision.images.annotate".
res, err := client.ImagesService().Annotate(batch).Do()
if err != nil {
panic(err)
}
```
## Example
### Pigeon
#### input
```shell
$ pigeon -label assets/pigeon.png
```
#### output
```json
[
{
"labelAnnotations": [
{
"description": "bird",
"mid": "/m/015p6",
"score": 0.825656
},
{
"description": "anatidae",
"mid": "/m/01c_0l",
"score": 0.58264238
}
]
}
]
```
### Lenna
#### input
```shell
$ pigeon -safe-search assets/lenna.jpg
```
#### output
```json
[
{
"safeSearchAnnotation": {
"adult": "POSSIBLE",
"medical": "UNLIKELY",
"spoof": "VERY_UNLIKELY",
"violence": "VERY_UNLIKELY"
}
}
]
```
## License
[The MIT License (MIT)](http://zquestz.mit-license.org/)
## Author
Shintaro Kaneko