translate

package
v0.189.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2024 License: BSD-3-Clause Imports: 16 Imported by: 5

Documentation

Overview

Package translate provides access to the Google Cloud Translation API.

This package is DEPRECATED. Use package cloud.google.com/go/translate instead.

For product documentation, see: https://code.google.com/apis/language/translate/v2/getting_started.html

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/translate/v2"
...
ctx := context.Background()
translateService, err := translate.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

translateService, err := translate.NewService(ctx, option.WithScopes(translate.CloudTranslationScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

translateService, err := translate.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
translateService, err := translate.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// Translate text from one language to another using Google Translate
	CloudTranslationScope = "https://www.googleapis.com/auth/cloud-translation"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type DetectLanguageRequest

type DetectLanguageRequest struct {
	// Q: The input text upon which to perform language detection. Repeat
	// this
	// parameter to perform language detection on multiple text inputs.
	Q []string `json:"q,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Q") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Q") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DetectLanguageRequest: The request message for language detection.

func (DetectLanguageRequest) MarshalJSON

func (s DetectLanguageRequest) MarshalJSON() ([]byte, error)

type DetectionsDetectCall

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

func (*DetectionsDetectCall) Context

Context sets the context to be used in this call's Do method.

func (*DetectionsDetectCall) Do

Do executes the "language.detections.detect" call. Any non-2xx status code is an error. Response headers are in either *DetectionsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DetectionsDetectCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DetectionsDetectCall) Header

func (c *DetectionsDetectCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type DetectionsListCall

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

func (*DetectionsListCall) Context

Context sets the context to be used in this call's Do method.

func (*DetectionsListCall) Do

Do executes the "language.detections.list" call. Any non-2xx status code is an error. Response headers are in either *DetectionsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DetectionsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*DetectionsListCall) Header

func (c *DetectionsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*DetectionsListCall) IfNoneMatch

func (c *DetectionsListCall) IfNoneMatch(entityTag string) *DetectionsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type DetectionsListResponse

type DetectionsListResponse struct {
	// Detections: A detections contains detection results of several text
	Detections [][]*DetectionsResourceItem `json:"detections,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Detections") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Detections") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (DetectionsListResponse) MarshalJSON

func (s DetectionsListResponse) MarshalJSON() ([]byte, error)

type DetectionsResourceItem

type DetectionsResourceItem struct {
	// Confidence: The confidence of the detection result of this language.
	Confidence float64 `json:"confidence,omitempty"`
	// IsReliable: A boolean to indicate is the language detection result reliable.
	IsReliable bool `json:"isReliable,omitempty"`
	// Language: The language we detected.
	Language string `json:"language,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Confidence") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (DetectionsResourceItem) MarshalJSON

func (s DetectionsResourceItem) MarshalJSON() ([]byte, error)

func (*DetectionsResourceItem) UnmarshalJSON

func (s *DetectionsResourceItem) UnmarshalJSON(data []byte) error

type DetectionsService

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

func NewDetectionsService

func NewDetectionsService(s *Service) *DetectionsService

func (*DetectionsService) Detect

func (r *DetectionsService) Detect(detectlanguagerequest *DetectLanguageRequest) *DetectionsDetectCall

Detect: Detects the language of text within a request.

func (*DetectionsService) List

List: Detects the language of text within a request.

  • q: The input text upon which to perform language detection. Repeat this

parameter to perform language detection on multiple text inputs.

type GetSupportedLanguagesRequest

type GetSupportedLanguagesRequest struct {
	// Target: The language to use to return localized, human readable names of
	// supported
	// languages.
	Target string `json:"target,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Target") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Target") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GetSupportedLanguagesRequest: The request message for discovering supported languages.

func (GetSupportedLanguagesRequest) MarshalJSON

func (s GetSupportedLanguagesRequest) MarshalJSON() ([]byte, error)

type LanguagesListCall

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

func (*LanguagesListCall) Context

Context sets the context to be used in this call's Do method.

func (*LanguagesListCall) Do

Do executes the "language.languages.list" call. Any non-2xx status code is an error. Response headers are in either *LanguagesListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*LanguagesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*LanguagesListCall) Header

func (c *LanguagesListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*LanguagesListCall) IfNoneMatch

func (c *LanguagesListCall) IfNoneMatch(entityTag string) *LanguagesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*LanguagesListCall) Model

func (c *LanguagesListCall) Model(model string) *LanguagesListCall

Model sets the optional parameter "model": The model type for which supported languages should be returned.

func (*LanguagesListCall) Target

func (c *LanguagesListCall) Target(target string) *LanguagesListCall

Target sets the optional parameter "target": The language to use to return localized, human readable names of supported languages.

type LanguagesListResponse

type LanguagesListResponse struct {
	// Languages: List of source/target languages supported by the translation API.
	// If target parameter is unspecified, the list is sorted by the ASCII code
	// point order of the language code. If target parameter is specified, the list
	// is sorted by the collation order of the language name in the target
	// language.
	Languages []*LanguagesResource `json:"languages,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Languages") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Languages") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (LanguagesListResponse) MarshalJSON

func (s LanguagesListResponse) MarshalJSON() ([]byte, error)

type LanguagesResource

type LanguagesResource struct {
	// Language: Supported language code, generally consisting of its ISO
	// 639-1
	// identifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes
	// including
	// language + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH')
	Language string `json:"language,omitempty"`
	// Name: Human readable name of the language localized to the target language.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Language") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Language") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (LanguagesResource) MarshalJSON

func (s LanguagesResource) MarshalJSON() ([]byte, error)

type LanguagesService

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

func NewLanguagesService

func NewLanguagesService(s *Service) *LanguagesService

func (*LanguagesService) List

List: Returns a list of supported languages for translation.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Detections *DetectionsService

	Languages *LanguagesService

	Translations *TranslationsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type TranslateTextRequest

type TranslateTextRequest struct {
	// Format: The format of the source text, in either HTML (default) or
	// plain-text. A
	// value of "html" indicates HTML and a value of "text" indicates plain-text.
	Format string `json:"format,omitempty"`
	// Model: The `model` type requested for this translation. Valid values
	// are
	// listed in public documentation.
	Model string `json:"model,omitempty"`
	// Q: The input text to translate. Repeat this parameter to perform
	// translation
	// operations on multiple text inputs.
	Q []string `json:"q,omitempty"`
	// Source: The language of the source text, set to one of the language codes
	// listed in
	// Language Support. If the source language is not specified, the API
	// will
	// attempt to identify the source language automatically and return it
	// within
	// the response.
	Source string `json:"source,omitempty"`
	// Target: The language to use for translation of the input text, set to one of
	// the
	// language codes listed in Language Support.
	Target string `json:"target,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Format") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Format") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TranslateTextRequest: The main translation request message for the Cloud Translation API.

func (TranslateTextRequest) MarshalJSON

func (s TranslateTextRequest) MarshalJSON() ([]byte, error)

type TranslationsListCall

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

func (*TranslationsListCall) Cid

Cid sets the optional parameter "cid": The customization id for translate

func (*TranslationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*TranslationsListCall) Do

Do executes the "language.translations.list" call. Any non-2xx status code is an error. Response headers are in either *TranslationsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TranslationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*TranslationsListCall) Format

Format sets the optional parameter "format": The format of the source text, in either HTML (default) or plain-text. A value of "html" indicates HTML and a value of "text" indicates plain-text.

Possible values:

"html" - Specifies the input is in HTML
"text" - Specifies the input is in plain textual format

func (*TranslationsListCall) Header

func (c *TranslationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*TranslationsListCall) IfNoneMatch

func (c *TranslationsListCall) IfNoneMatch(entityTag string) *TranslationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*TranslationsListCall) Model

Model sets the optional parameter "model": The `model` type requested for this translation. Valid values are listed in public documentation.

func (*TranslationsListCall) Source

Source sets the optional parameter "source": The language of the source text, set to one of the language codes listed in Language Support. If the source language is not specified, the API will attempt to identify the source language automatically and return it within the response.

type TranslationsListResponse

type TranslationsListResponse struct {
	// Translations: Translations contains list of translation results of given
	// text
	Translations []*TranslationsResource `json:"translations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Translations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Translations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TranslationsListResponse: The main language translation response message.

func (TranslationsListResponse) MarshalJSON

func (s TranslationsListResponse) MarshalJSON() ([]byte, error)

type TranslationsResource

type TranslationsResource struct {
	// DetectedSourceLanguage: The source language of the initial request, detected
	// automatically, if
	// no source language was passed within the initial request. If the
	// source language was passed, auto-detection of the language will not
	// occur and this field will be empty.
	DetectedSourceLanguage string `json:"detectedSourceLanguage,omitempty"`
	// Model: The `model` type used for this translation. Valid values are
	// listed in public documentation. Can be different from requested
	// `model`.
	// Present only if specific model type was explicitly requested.
	Model string `json:"model,omitempty"`
	// TranslatedText: Text translated into the target language.
	TranslatedText string `json:"translatedText,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DetectedSourceLanguage") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DetectedSourceLanguage") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

func (TranslationsResource) MarshalJSON

func (s TranslationsResource) MarshalJSON() ([]byte, error)

type TranslationsService

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

func NewTranslationsService

func NewTranslationsService(s *Service) *TranslationsService

func (*TranslationsService) List

func (r *TranslationsService) List(q []string, target string) *TranslationsListCall

List: Translates input text, returning translated text.

  • q: The input text to translate. Repeat this parameter to perform translation

operations on multiple text inputs.

  • target: The language to use for translation of the input text, set to one of the

language codes listed in Language Support.

func (*TranslationsService) Translate

func (r *TranslationsService) Translate(translatetextrequest *TranslateTextRequest) *TranslationsTranslateCall

Translate: Translates input text, returning translated text.

type TranslationsTranslateCall

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

func (*TranslationsTranslateCall) Context

Context sets the context to be used in this call's Do method.

func (*TranslationsTranslateCall) Do

Do executes the "language.translations.translate" call. Any non-2xx status code is an error. Response headers are in either *TranslationsListResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*TranslationsTranslateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*TranslationsTranslateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL