README
¶
Cloud Translation API
Go Client Library for Cloud Translation API.
Install
go get cloud.google.com/go/translate
Stability
The stability of this module is indicated by SemVer.
However, a v1+ module may have breaking changes in two scenarios:
- Packages with
alphaorbetain the import path - The GoDoc has an explicit stability disclaimer (for example, for an experimental feature).
Go Version Support
See the Go Versions Supported section in the root directory's README.
Authorization
See the Authorization section in the root directory's README.
Contributing
Contributions are welcome. Please, see the CONTRIBUTING document for details.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Contributor Code of Conduct for more information.
Documentation
¶
Overview ¶
Package translate is the v2 client for the Google Translation API.
PLEASE NOTE: We recommend using the new v3 client for new projects: https://cloud.google.com/go/translate/apiv3.
See https://cloud.google.com/translation for details.
Index ¶
- Constants
- type Client
- func (c *Client) Close() error
- func (c *Client) DetectLanguage(ctx context.Context, inputs []string) ([][]Detection, error)
- func (c *Client) SupportedLanguages(ctx context.Context, target language.Tag) ([]Language, error)
- func (c *Client) Translate(ctx context.Context, inputs []string, target language.Tag, opts *Options) ([]Translation, error)
- type Detection
- type Format
- type Language
- type Options
- type Translation
Examples ¶
Constants ¶
const Scope = raw.CloudPlatformScope
Scope is the OAuth2 scope required by the Google Cloud Vision API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a client for the translate API.
func NewClient ¶
NewClient constructs a new Client that can perform Translation operations.
You can find or create API key for your project from the Credentials page of the Developers Console (console.developers.google.com).
Example ¶
package main
import (
"context"
"cloud.google.com/go/translate"
)
func main() {
ctx := context.Background()
client, err := translate.NewClient(ctx)
if err != nil {
// TODO: handle error.
}
// Use the client.
// Close the client when finished.
if err := client.Close(); err != nil {
// TODO: handle error.
}
}
Output:
func (*Client) Close ¶
Close closes any resources held by the client. Close should be called when the client is no longer needed. It need not be called at program exit.
func (*Client) DetectLanguage ¶
DetectLanguage attempts to determine the language of the inputs. Each input string may be in a different language.
Each slice of Detections in the return value corresponds with one input string. A slice of Detections holds multiple hypotheses for the language of a single input string.
Example ¶
package main
import (
"context"
"fmt"
"cloud.google.com/go/translate"
)
func main() {
ctx := context.Background()
client, err := translate.NewClient(ctx)
if err != nil {
// TODO: handle error.
}
ds, err := client.DetectLanguage(ctx, []string{"Today is Monday"})
if err != nil {
// TODO: handle error.
}
fmt.Println(ds)
}
Output:
func (*Client) SupportedLanguages ¶
SupportedLanguages returns a list of supported languages for translation. The target parameter is the language to use to return localized, human readable names of supported languages.
Example ¶
package main
import (
"context"
"fmt"
"cloud.google.com/go/translate"
"golang.org/x/text/language"
)
func main() {
ctx := context.Background()
client, err := translate.NewClient(ctx)
if err != nil {
// TODO: handle error.
}
langs, err := client.SupportedLanguages(ctx, language.English)
if err != nil {
// TODO: handle error.
}
fmt.Println(langs)
}
Output:
func (*Client) Translate ¶
func (c *Client) Translate(ctx context.Context, inputs []string, target language.Tag, opts *Options) ([]Translation, error)
Translate one or more strings of text from a source language to a target language. All inputs must be in the same language.
The target parameter supplies the language to translate to. The supported languages are listed at https://cloud.google.com/translation/v2/translate-reference#supported_languages. You can also call the SupportedLanguages method.
The returned Translations appear in the same order as the inputs.
Example ¶
package main
import (
"context"
"fmt"
"cloud.google.com/go/translate"
"golang.org/x/text/language"
)
func main() {
ctx := context.Background()
client, err := translate.NewClient(ctx)
if err != nil {
// TODO: handle error.
}
translations, err := client.Translate(ctx,
[]string{"Le singe est sur la branche"}, language.English,
&translate.Options{
Source: language.French,
Format: translate.Text,
})
if err != nil {
// TODO: handle error.
}
fmt.Println(translations[0].Text)
}
Output:
type Detection ¶
type Detection struct {
// Language is the code of the language detected.
Language language.Tag
// Confidence is a number from 0 to 1, with higher numbers indicating more
// confidence in the detection.
Confidence float64
// IsReliable indicates whether the language detection result is reliable.
IsReliable bool
}
Detection represents information about a language detected in an input.
type Language ¶
type Language struct {
// Name is the human-readable name of the language.
Name string
// Tag is a standard code for the language.
Tag language.Tag
}
A Language describes a language supported for translation.
type Options ¶
type Options struct {
// Source is the language of the input strings. If empty, the service will
// attempt to identify the source language automatically and return it within
// the response.
Source language.Tag
// Format describes the format of the input texts. The choices are HTML or
// Text. The default is HTML.
Format Format
// The model to use for translation. The choices are "nmt" or "base". The
// default is "base".
Model string
}
Options contains options for Translate.
type Translation ¶
type Translation struct {
// Text is the input text translated into the target language.
Text string
// Source is the detected language of the input text, if source was
// not supplied to Client.Translate. If source was supplied, this field
// will be empty.
Source language.Tag
// Model is the model that was used for translation.
// It may not match the model provided as an option to Client.Translate.
Model string
}
Translation contains the results of translating a piece of text.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package translate is an auto-generated package for the Cloud Translation API.
|
Package translate is an auto-generated package for the Cloud Translation API. |