Documentation

Overview

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.

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

            func (*Client) AnalyzeEntitySentiment

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

              Example
              Output:
              
              

              func (*Client) AnalyzeSentiment

                AnalyzeSentiment analyzes the sentiment of the provided text.

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

                  func (*Client) AnnotateText

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

                    Example
                    Output:
                    
                    

                    func (*Client) ClassifyText

                      ClassifyText classifies a document into categories.

                      Example
                      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 a connection to the API service.

                          Deprecated.