language

package
v0.27.0 Latest Latest
Warning

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

Go to latest
Published: Sep 4, 2018 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

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

NOTE: This package is in alpha. It is not stable, and is likely to change.

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

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

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

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.

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
ctx := context.Background()
c, err := language.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

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
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
Output:

func (*Client) AnalyzeEntitySentiment

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
Output:

func (*Client) AnalyzeSentiment

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
Output:

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
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
Output:

func (*Client) AnnotateText

AnnotateText a convenience method that provides all syntax, sentiment, entity, and classification 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
Output:

func (*Client) ClassifyText added in v0.14.0

ClassifyText classifies a document into categories.

Example
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
Output:

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.

Jump to

Keyboard shortcuts

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