Package cloud.google.com/go/language/apiv1beta2

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

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

Use of Context

The ctx passed to NewClient is used for authentication requests and for 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.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

CallOptions

type CallOptions struct {
	AnalyzeSentiment       []gax.CallOption
	AnalyzeEntities        []gax.CallOption
	AnalyzeEntitySentiment []gax.CallOption
	AnalyzeSyntax          []gax.CallOption
	ClassifyText           []gax.CallOption
	AnnotateText           []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

	// 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.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new language service client.

Provides text analysis operations such as sentiment analysis and entity recognition.

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use client.
	_ = c
}

func (*Client) AnalyzeEntities

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

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
	languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"
)

func main() {
	// import languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"

	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &languagepb.AnalyzeEntitiesRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.AnalyzeEntities(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) AnalyzeEntitySentiment

AnalyzeEntitySentiment finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
	languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"
)

func main() {
	// import languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"

	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &languagepb.AnalyzeEntitySentimentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.AnalyzeEntitySentiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) AnalyzeSentiment

AnalyzeSentiment analyzes the sentiment of the provided text.

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
	languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"
)

func main() {
	// import languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"

	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &languagepb.AnalyzeSentimentRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.AnalyzeSentiment(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) AnalyzeSyntax

AnalyzeSyntax analyzes the syntax of the text and provides sentence boundaries and tokenization along with part-of-speech tags, dependency trees, and other properties.

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
	languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"
)

func main() {
	// import languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"

	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &languagepb.AnalyzeSyntaxRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.AnalyzeSyntax(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) AnnotateText

AnnotateText a convenience method that provides all syntax, sentiment, entity, and classification features in one call.

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
	languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"
)

func main() {
	// import languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"

	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &languagepb.AnnotateTextRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.AnnotateText(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ClassifyText

ClassifyText classifies a document into categories.

Example

package main

import (
	language "cloud.google.com/go/language/apiv1beta2"
	"context"
	languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"
)

func main() {
	// import languagepb "google.golang.org/genproto/googleapis/cloud/language/v1beta2"

	ctx := context.Background()
	c, err := language.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &languagepb.ClassifyTextRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.ClassifyText(ctx, req)
	if err != 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 when the client is no longer required.

func (*Client) Connection

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

Connection returns a connection to the API service.

Deprecated.