Skip to content

Latest commit

 

History

History
228 lines (148 loc) · 6.05 KB

README.md

File metadata and controls

228 lines (148 loc) · 6.05 KB
Raw

TUPU GO SDK

Golang SDK for TUPU visual recognition service (v1.6.1)

https://www.tuputech.com

Changelogs

v1.10.0

  • add speech stream SDK and example

v1.9.0

  • add video(async/sync) sdk and adjust speech async sdk

v1.8.0

  • add testSync method and lib

v1.7.4

  • image remove limited and memory optimization

v1.7.3

  • image api with function options

v1.7.2

  • add task param to image recognition

v1.7.1

  • refactor speech sdk

v1.7

  • add speech method and lib

v1.6.1

  • fix returning data when it's not JSON data

v1.6

  • fix to return failure response status code

v1.5

  • support setting http client

v1.4

  • removed log.Fatal

v1.3

  • fixed bug in parsing result

v1.2

  • add shortcut methods for URL or path

v1.1

  • 1st ready version

Installation

​ go get github.com/tuputech/tupu-go-sdk/recognition

Example

  1. Image recognition interface example
  2. shortSpeech recognition interface example
  3. longSpeech recognition interface example

Image Recognition API

import "github.com/tuputech/recognition"

func PerformWithURL

func (h *Handler) PerformWithURL(secretID string, imageURLs []string, tags []string) (result string, statusCode int, e error)

PerformWithURL return a json string and a int express response, a error identifying success of failure

It is useful for the recognition function using remote image

Params Descrition

  • secretId: secret-id for recognition tasks
  • imageURLs: array of image URLs
  • tags: array of tags for images (optional)

func PerformWithPath

func (h *Handler) PerformWithPath(secretID string, imagePaths []string, tags []string) (result string, statusCode int, e error)

PerformWithPath return a json string and a int express response, a error identifying success of failure

It is useful for the recognition function using local image

Params Descrition

  • secretId: secret-id for recognition tasks
  • imagePaths: array of image paths
  • tags: array of tags for images (optional)

func Perform

func (h *Handler) Perform(secretID string, images []*Image, tags []string) (result string, statusCode int, e error)

Perform return a json string and a int express response, a error identifying success of failure

Construct the data structures we provide to execute reccognition

There are three functions you can use to construct an Image object：

  1. func NewRemoteImage(url string) *Image
  2. func NewLocalImage(path string) *Image
  3. func NewBinaryImage(buf []byte, filename string) *Image

Params Descrition

  • secretId: secret-id for recognition tasks
  • images: array of Image struct, but don't mix use of URL and path/binary in one call
  • tags: array of tags for images (optional)

Speech Recognition API

Contains Package speechsync and Package speechasync

Speech Sync API

import "github.com/tuputech/recognition/speech/speechsync"

func PerforWithBinary

func (syncHdler *SyncHandler) PerformWithBinary(secretID string, binaryData map[string][]byte) (result string, statusCode int, err error)

PerformWithBinary return a json string and a int express response, a error identifying success of failure

Identification with binaries is valid, but binaries need to be built with the Map type for filetype supported only in amr, mp3, wmv, wav, flv format

Params Descrition

  • secretID: secret-id for recognition task
  • binaryData: map type, key means file name, value means binary data

func PerforWithPath

func (syncHdler *SyncHandler) PerformWithPath(secretID string, speechPaths []string) (result string, statusCode int, err error)

PerformWithPath return a json string and a int express response, a error identifying success of failure

It is useful for the recognition function using local speech file

Params Descrition

  • secretID: secret-id for recognition task
  • speechPaths: local speech paths

func PerforWithURL

func (syncHdler *SyncHandler) PerformWithURL(secretID string, URLs []string) (result string, statusCode int, err error)

PerformWithURL return a json string and a int express response, a error identifying success of failure

It is useful for the recognition function using remote speech file

Params Descrition

  • secretID: secret-id for recognition task
  • URLs: remote speech address

Speech Async API

import "github.com/tuputech/recognition/speech/speechasync"

func Perform

func (asyncHdler *AsyncHandler) Perform(secretID string, speechAsync *SpeechAsync) (result string, statusCode int, err error)

Perform return a json string and a int express response, a error identifying success of failure

Params Descrition

  • secretID: secret-id for recognition task
  • speechAsync: SpeechAsync struct wrapper async speech message for request

Only remote files are supported, and request information is created via structure SpeechAsync

// SpeechAsync is a structure that encapsulates async speech messages
type SpeechAsync struct {
   // FileRemoteURL represents the address of the big voice, can't be empty
   FileRemoteURL string 
   // CallbackUrl represents the address of the callback result, cant' be empty
   CallbackURL string 
   // CallbackRule represents the Rule of the callback, empty is using default rule, `all` is callback all result
   CallbackRule string 
   // RoomID represents the room id
   RoomID string 
   // UserID represents the user id
   UserID string 
   // ForumID represents the forum id
   ForumID string
}

License

MIT