mstranslator

README

mstranslator

The "mstranslator" is a Micrsoft Translator Service client which written by Golang.

What is Microsoft Translator

Microsoft Translator is a cloud based automatic translation service. (Refer here for more detail).

Here is another site for Microsoft Translator API.

Installation

go get github.com/PavelPavells/mstranslator

How to use it

Sign-up for Microsoft Translator API (see here for more detail) and get your developer credentials. Use the client ID and secret to instantiate a translator as shown below.

        package main
        
        import (
        	"fmt"
        	"log"
        
                ms "github.com/kkdai/mstranslator"
                )
        
        func main() {
        	msClient := ms.NewClient("YourClientID", "YourClientSecret")
        
        	//Translate "Hello World" from English to France.
        	translation, err := msClient.Translate("Hello World!", "en", "de")
        	if err != nil {
        		log.Panicf("Error : %s", err.Error())
        	}
        	fmt.Println(translation) //Hallo Welt!        
        }

Check example for more detail.

Example on mstranslator

Implemented APIs

• Detect
• DetectArray
• GetLanguageNames
• GetLanguagesForTranslate
• GetLanguagesForSpeak
• GetTranslations
• Translate
• TransformText
• Speak

Unimplement APIs (Yet)

• AddTranslation
• AddTranslationArray
• BreakSentences
• GetTranslationsArray
• TranslateArray

Contribute

Please open up an issue on GitHub before you put a lot efforts on pull request. The code submitting to PR must be filtered with gofmt

Inspired

This project is inspired by https://github.com/st3v/translator.

License

This package is licensed under MIT license. See LICENSE for details.

Documentation

Index

• Constants
• type Authenticator
  • func NewAuthenticator(cid, csecret string) *Authenticator
  • func (auth *Authenticator) GetToken() string
• type Client
  • func NewClient(clientID, clientSecret string) *Client
  • func (c *Client) Detect(text string) (string, error)
  • func (c *Client) DetectArray(text []string) ([]string, error)
  • func (c *Client) GetLanguageNames(codes []string) ([]string, error)
  • func (c *Client) GetLanguagesForSpeak() ([]string, error)
  • func (c *Client) GetLanguagesForTranslate() ([]string, error)
  • func (c *Client) GetTranslations(text, from, to string, maxTranslations int) ([]ResponseTranslationMatch, error)
  • func (c *Client) Speak(text, lang, outFormat string) ([]byte, error)
  • func (c *Client) TransformText(lang, category, text string) (string, error)
  • func (c *Client) Translate(text, from, to string) (string, error)
• type GetTranslationResponse
• type LanguageProvider
  • func NewLanguageProvider(auth *Authenticator) *LanguageProvider
  • func (l *LanguageProvider) Detect(text string) (string, error)
  • func (l *LanguageProvider) DetectArray(text []string) ([]string, error)
  • func (l *LanguageProvider) GetLanguageNames(codes []string) ([]string, error)
  • func (l *LanguageProvider) GetLanguagesForSpeak() ([]string, error)
  • func (l *LanguageProvider) GetLanguagesForTranslate() ([]string, error)
  • func (l *LanguageProvider) GetTranslations(text, from, to string, maxTranslations int) ([]ResponseTranslationMatch, error)
• type ResponseArray
• type ResponseToken
• type ResponseTranslationMatch
• type ResponseTranslations
• type ResponseXML
• type TransformTextResponse
• type TranslateProvider
  • func NewTranslateProvider(auth *Authenticator) *TranslateProvider
  • func (t *TranslateProvider) Speak(text, lang, outFormat string) ([]byte, error)
  • func (t *TranslateProvider) TransformText(lang, category, text string) (string, error)
  • func (t *TranslateProvider) Translate(text, from, to string) (string, error)
• type XMLIntValue
• type XMLStringValue

Constants

const (
	API_URL   = "https://datamarket.accesscontrol.windows.net/v2/OAuth2-13/"
	API_SCOPE = "http://api.microsofttranslator.com"

	TransformTextURL            = "http://api.microsofttranslator.com/V3/json/TransformText"
	ServiceURL                  = "http://api.microsofttranslator.com/v2/Http.svc/"
	TranslationURL              = ServiceURL + "Translate"
	GetTranslationsURL          = ServiceURL + "GetTranslations"
	DetectURL                   = ServiceURL + "Detect"
	DetectArrayURL              = ServiceURL + "DetectArray"
	SpeakURL                    = ServiceURL + "Speak"
	GetLanguageNamesURL         = ServiceURL + "GetLanguageNames"
	GetLanguagesForTranslateURL = ServiceURL + "GetLanguagesForTranslate"
	GetLanguagesForSpeakURL     = ServiceURL + "GetLanguagesForSpeak"
)

Types

type Authenticator

type Authenticator struct {
	ClientID     string
	ClientSecret string
	ClientToken  string
}

func NewAuthenticator

func NewAuthenticator(cid, csecret string) *Authenticator

func (*Authenticator) GetToken

func (auth *Authenticator) GetToken() string

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(clientID, clientSecret string) *Client

func (*Client) Detect

func (c *Client) Detect(text string) (string, error)

func (*Client) DetectArray

func (c *Client) DetectArray(text []string) ([]string, error)

func (*Client) GetLanguageNames

func (c *Client) GetLanguageNames(codes []string) ([]string, error)

func (*Client) GetLanguagesForSpeak

func (c *Client) GetLanguagesForSpeak() ([]string, error)

func (*Client) GetLanguagesForTranslate

func (c *Client) GetLanguagesForTranslate() ([]string, error)

func (*Client) GetTranslations

func (c *Client) GetTranslations(text, from, to string, maxTranslations int) ([]ResponseTranslationMatch, error)

func (*Client) Speak

func (c *Client) Speak(text, lang, outFormat string) ([]byte, error)

func (*Client) TransformText

func (c *Client) TransformText(lang, category, text string) (string, error)

func (*Client) Translate

func (c *Client) Translate(text, from, to string) (string, error)

type GetTranslationResponse

type GetTranslationResponse struct {
	XMLName      xml.Name             `xml:"GetTranslationResponse"`
	Translations ResponseTranslations `xml:"Translations"`
}

type LanguageProvider

type LanguageProvider struct {
	// contains filtered or unexported fields
}

func NewLanguageProvider

func NewLanguageProvider(auth *Authenticator) *LanguageProvider

func (*LanguageProvider) Detect

func (l *LanguageProvider) Detect(text string) (string, error)

func (*LanguageProvider) DetectArray

func (l *LanguageProvider) DetectArray(text []string) ([]string, error)

func (*LanguageProvider) GetLanguageNames

func (l *LanguageProvider) GetLanguageNames(codes []string) ([]string, error)

Retrieves friendly names for the languages passed in as the parameter languageCodes, and localized using the passed locale language.

func (*LanguageProvider) GetLanguagesForSpeak

func (l *LanguageProvider) GetLanguagesForSpeak() ([]string, error)

func (*LanguageProvider) GetLanguagesForTranslate

func (l *LanguageProvider) GetLanguagesForTranslate() ([]string, error)

func (*LanguageProvider) GetTranslations

func (l *LanguageProvider) GetTranslations(text, from, to string, maxTranslations int) ([]ResponseTranslationMatch, error)

type ResponseArray

type ResponseArray struct {
	XMLName           xml.Name `xml:"ArrayOfstring"`
	Namespace         string   `xml:"xmlns,attr"`
	InstanceNamespace string   `xml:"xmlns:i,attr"`
	Strings           []string `xml:"string"`
}

type ResponseToken

type ResponseToken struct {
	TokenType   string `json:"token_type"`
	AccessToken string `json:"access_token"`
	ExpiresIn   string `json:"expires_in"`
	Scope       string `json:"scope"`
}

type ResponseTranslationMatch

type ResponseTranslationMatch struct {
	Count               XMLIntValue    `xml:"Count"`
	MatchDegree         XMLIntValue    `xml:"MatchDegree"`
	MatchedOriginalText XMLStringValue `xml:"MatchedOriginalText"`
	Rating              XMLIntValue    `xml:"Rating"`
	TranslatedText      XMLStringValue `xml:"TranslatedText"`
}

type ResponseTranslations

type ResponseTranslations struct {
	TransMatch []ResponseTranslationMatch `xml:"TranslationMatch"`
}

type ResponseXML

type ResponseXML struct {
	XMLName   xml.Name `xml:"string"`
	Namespace string   `xml:"xmlns,attr"`
	Value     string   `xml:",innerxml"`
}

type TransformTextResponse

type TransformTextResponse struct {
	ErrorCondition   int    `json:"ec"`
	ErrorDescriptive string `json:"em"`
	Sentence         string `json:"sentence"`
}

type TranslateProvider

type TranslateProvider struct {
	// contains filtered or unexported fields
}

func NewTranslateProvider

func NewTranslateProvider(auth *Authenticator) *TranslateProvider

func (*TranslateProvider) Speak

func (t *TranslateProvider) Speak(text, lang, outFormat string) ([]byte, error)

func (*TranslateProvider) TransformText

func (t *TranslateProvider) TransformText(lang, category, text string) (string, error)

func (*TranslateProvider) Translate

func (t *TranslateProvider) Translate(text, from, to string) (string, error)

type XMLIntValue

type XMLIntValue struct {
	Text int `xml:",chardata"`
}

type XMLStringValue

type XMLStringValue struct {
	Text string `xml:",chardata"`
}