language

Documentation

Overview

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

Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, and text annotations.

Index

• func DefaultAuthScopes() []string
• type CallOptions
• type Client
  • func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
  • func (c *Client) AnalyzeEntities(ctx context.Context, req *languagepb.AnalyzeEntitiesRequest, ...) (*languagepb.AnalyzeEntitiesResponse, error)
  • func (c *Client) AnalyzeEntitySentiment(ctx context.Context, req *languagepb.AnalyzeEntitySentimentRequest, ...) (*languagepb.AnalyzeEntitySentimentResponse, error)
  • func (c *Client) AnalyzeSentiment(ctx context.Context, req *languagepb.AnalyzeSentimentRequest, ...) (*languagepb.AnalyzeSentimentResponse, error)
  • func (c *Client) AnalyzeSyntax(ctx context.Context, req *languagepb.AnalyzeSyntaxRequest, ...) (*languagepb.AnalyzeSyntaxResponse, error)
  • func (c *Client) AnnotateText(ctx context.Context, req *languagepb.AnnotateTextRequest, ...) (*languagepb.AnnotateTextResponse, error)
  • func (c *Client) Close() error
  • func (c *Client) Connection() *grpc.ClientConn
  • func (c *Client) SetGoogleClientInfo(keyval ...string)

Examples

• Client.AnalyzeEntities
• Client.AnalyzeEntitySentiment
• Client.AnalyzeSentiment
• Client.AnalyzeSyntax
• Client.AnnotateText
• NewClient

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the authentication scopes required by this package.

Types

type CallOptions

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

CallOptions contains the retry settings for each method of Client.

type Client

type Client struct {

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

Client is a client for interacting with Google Cloud Natural Language API.

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

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

func (*Client) AnalyzeEntities

func (c *Client) AnalyzeEntities(ctx context.Context, req *languagepb.AnalyzeEntitiesRequest, opts ...gax.CallOption) (*languagepb.AnalyzeEntitiesResponse, error)

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

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

func (c *Client) AnalyzeEntitySentiment(ctx context.Context, req *languagepb.AnalyzeEntitySentimentRequest, opts ...gax.CallOption) (*languagepb.AnalyzeEntitySentimentResponse, error)

AnalyzeEntitySentiment finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

Example

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

func (c *Client) AnalyzeSentiment(ctx context.Context, req *languagepb.AnalyzeSentimentRequest, opts ...gax.CallOption) (*languagepb.AnalyzeSentimentResponse, error)

AnalyzeSentiment analyzes the sentiment of the provided text.

Example

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

func (c *Client) AnalyzeSyntax(ctx context.Context, req *languagepb.AnalyzeSyntaxRequest, opts ...gax.CallOption) (*languagepb.AnalyzeSyntaxResponse, error)

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

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

func (c *Client) AnnotateText(ctx context.Context, req *languagepb.AnnotateTextRequest, opts ...gax.CallOption) (*languagepb.AnnotateTextResponse, error)

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

Example

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) 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 the client's connection to the API service.

func (*Client) SetGoogleClientInfo

func (c *Client) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.