Cloud Natural Language API v1 - Package cloud.google.com/go/language/apiv1 (v1.14.6)

Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.

Package language is an auto-generated package for theCloud Natural Language API.

Provides natural language understanding technologies, such as sentimentanalysis, entity recognition, entity sentiment analysis, and other textannotations, to developers.

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/language/apiv1@latestctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req:=&languagepb.AnalyzeEntitiesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#AnalyzeEntitiesRequest.}resp,err:=c.AnalyzeEntities(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp

Use of Context

The ctx passed to NewClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

funcDefaultAuthScopes()[]string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

CallOptions

typeCallOptionsstruct{AnalyzeSentiment[]gax.CallOptionAnalyzeEntities[]gax.CallOptionAnalyzeEntitySentiment[]gax.CallOptionAnalyzeSyntax[]gax.CallOptionClassifyText[]gax.CallOptionModerateText[]gax.CallOptionAnnotateText[]gax.CallOption}

CallOptions contains the retry settings for each method of Client.

Client

typeClientstruct{// The call options for this service.CallOptions*CallOptions// contains filtered or unexported fields}

Client is a client for interacting with Cloud Natural Language API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Provides text analysis operations such as sentiment analysis and entityrecognition.

func NewClient

funcNewClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewClient creates a new language service client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

Provides text analysis operations such as sentiment analysis and entityrecognition.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewRESTClient

funcNewRESTClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewRESTClient creates a new language service rest client.

Provides text analysis operations such as sentiment analysis and entityrecognition.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*Client) AnalyzeEntities

AnalyzeEntities finds named entities (currently proper names and common nouns) in the textalong with entity types, salience, mentions for each entity, andother properties.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.AnalyzeEntitiesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#AnalyzeEntitiesRequest.}resp,err:=c.AnalyzeEntities(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) AnalyzeEntitySentiment

AnalyzeEntitySentiment finds entities, similar toAnalyzeEntitiesin the text and analyzes sentiment associated with each entity and itsmentions.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.AnalyzeEntitySentimentRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#AnalyzeEntitySentimentRequest.}resp,err:=c.AnalyzeEntitySentiment(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) AnalyzeSentiment

AnalyzeSentiment analyzes the sentiment of the provided text.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.AnalyzeSentimentRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#AnalyzeSentimentRequest.}resp,err:=c.AnalyzeSentiment(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) AnalyzeSyntax

AnalyzeSyntax analyzes the syntax of the text and provides sentence boundaries andtokenization along with part of speech tags, dependency trees, and otherproperties.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.AnalyzeSyntaxRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#AnalyzeSyntaxRequest.}resp,err:=c.AnalyzeSyntax(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) AnnotateText

AnnotateText a convenience method that provides all the features that analyzeSentiment,analyzeEntities, and analyzeSyntax provide in one call.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.AnnotateTextRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#AnnotateTextRequest.}resp,err:=c.AnnotateText(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ClassifyText

ClassifyText classifies a document into categories.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.ClassifyTextRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#ClassifyTextRequest.}resp,err:=c.ClassifyText(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) Close

func(c*Client)Close()error

Close closes the connection to the API service. The user should invoke this whenthe client is no longer required.

func (*Client) Connection (deprecated)

func(c*Client)Connection()*grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client) ModerateText

ModerateText moderates a document for harmful and sensitive categories.

Example

packagemainimport("context"language"cloud.google.com/go/language/apiv1"languagepb"cloud.google.com/go/language/apiv1/languagepb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=language.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&languagepb.ModerateTextRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/language/apiv1/languagepb#ModerateTextRequest.}resp,err:=c.ModerateText(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.