comprehend

package
v2.0.0-preview.4+incom... Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package comprehend provides the client and types for making API requests to Amazon Comprehend.

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

See https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27 for more information on this service.

See comprehend package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/comprehend/

Using the Client

To Amazon Comprehend with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Comprehend client Comprehend for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/comprehend/#New

Index

Constants

View Source 
const (

	// ErrCodeBatchSizeLimitExceededException for service response error code
	// "BatchSizeLimitExceededException".
	//
	// The number of documents in the request exceeds the limit of 25. Try your
	// request again with fewer documents.
	ErrCodeBatchSizeLimitExceededException = "BatchSizeLimitExceededException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal server error occurred. Retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeInvalidFilterException for service response error code
	// "InvalidFilterException".
	//
	// The filter specified for the ListTopicDetectionJobs operation is invalid.
	// Specify a different filter.
	ErrCodeInvalidFilterException = "InvalidFilterException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is invalid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeJobNotFoundException for service response error code
	// "JobNotFoundException".
	//
	// The specified job was not found. Check the job ID and try again.
	ErrCodeJobNotFoundException = "JobNotFoundException"

	// ErrCodeTextSizeLimitExceededException for service response error code
	// "TextSizeLimitExceededException".
	//
	// The size of the input text exceeds the limit. Use a smaller document.
	ErrCodeTextSizeLimitExceededException = "TextSizeLimitExceededException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// The number of requests exceeds the limit. Resubmit your request later.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnsupportedLanguageException for service response error code
	// "UnsupportedLanguageException".
	//
	// Amazon Comprehend can't process the language of the input text. For all APIs
	// except DetectDominantLanguage, Amazon Comprehend accepts only English or
	// Spanish text. For the DetectDominantLanguage API, Amazon Comprehend detects
	// 100 languages. For a list of languages, see how-languages
	ErrCodeUnsupportedLanguageException = "UnsupportedLanguageException"
)
View Source 
const (
	ServiceName = "comprehend" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchDetectDominantLanguageInput 

type BatchDetectDominantLanguageInput struct {

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document should contain at least 20 characters
	// and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguageRequest

func (BatchDetectDominantLanguageInput) GoString 

func (s BatchDetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (BatchDetectDominantLanguageInput) String 

func (s BatchDetectDominantLanguageInput) String() string

String returns the string representation

func (*BatchDetectDominantLanguageInput) Validate 

func (s *BatchDetectDominantLanguageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetectDominantLanguageItemResult 

type BatchDetectDominantLanguageItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`

	// One or more DominantLanguage objects describing the dominant languages in
	// the document.
	Languages []DominantLanguage `type:"list"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguageItemResult

func (BatchDetectDominantLanguageItemResult) GoString 

func (s BatchDetectDominantLanguageItemResult) GoString() string

GoString returns the string representation

func (BatchDetectDominantLanguageItemResult) String 

func (s BatchDetectDominantLanguageItemResult) String() string

String returns the string representation

type BatchDetectDominantLanguageOutput 

type BatchDetectDominantLanguageOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []BatchDetectDominantLanguageItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguageResponse

func (BatchDetectDominantLanguageOutput) GoString 

func (s BatchDetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (BatchDetectDominantLanguageOutput) SDKResponseMetadata 

func (s BatchDetectDominantLanguageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BatchDetectDominantLanguageOutput) String 

func (s BatchDetectDominantLanguageOutput) String() string

String returns the string representation

type BatchDetectDominantLanguageRequest 

type BatchDetectDominantLanguageRequest struct {
	*aws.Request
	Input *BatchDetectDominantLanguageInput
	Copy  func(*BatchDetectDominantLanguageInput) BatchDetectDominantLanguageRequest
}

BatchDetectDominantLanguageRequest is a API request type for the BatchDetectDominantLanguage API operation.

func (BatchDetectDominantLanguageRequest) Send 

func (r BatchDetectDominantLanguageRequest) Send() (*BatchDetectDominantLanguageOutput, error)

Send marshals and sends the BatchDetectDominantLanguage API request.

type BatchDetectEntitiesInput 

type BatchDetectEntitiesInput struct {

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `min:"1" type:"string" required:"true"`

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer than 5,000 bytes
	// of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntitiesRequest

func (BatchDetectEntitiesInput) GoString 

func (s BatchDetectEntitiesInput) GoString() string

GoString returns the string representation

func (BatchDetectEntitiesInput) String 

func (s BatchDetectEntitiesInput) String() string

String returns the string representation

func (*BatchDetectEntitiesInput) Validate 

func (s *BatchDetectEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetectEntitiesItemResult 

type BatchDetectEntitiesItemResult struct {

	// One or more Entity objects, one for each entity detected in the document.
	Entities []Entity `type:"list"`

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntitiesItemResult

func (BatchDetectEntitiesItemResult) GoString 

func (s BatchDetectEntitiesItemResult) GoString() string

GoString returns the string representation

func (BatchDetectEntitiesItemResult) String 

func (s BatchDetectEntitiesItemResult) String() string

String returns the string representation

type BatchDetectEntitiesOutput 

type BatchDetectEntitiesOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []BatchDetectEntitiesItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntitiesResponse

func (BatchDetectEntitiesOutput) GoString 

func (s BatchDetectEntitiesOutput) GoString() string

GoString returns the string representation

func (BatchDetectEntitiesOutput) SDKResponseMetadata 

func (s BatchDetectEntitiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BatchDetectEntitiesOutput) String 

func (s BatchDetectEntitiesOutput) String() string

String returns the string representation

type BatchDetectEntitiesRequest 

type BatchDetectEntitiesRequest struct {
	*aws.Request
	Input *BatchDetectEntitiesInput
	Copy  func(*BatchDetectEntitiesInput) BatchDetectEntitiesRequest
}

BatchDetectEntitiesRequest is a API request type for the BatchDetectEntities API operation.

func (BatchDetectEntitiesRequest) Send 

func (r BatchDetectEntitiesRequest) Send() (*BatchDetectEntitiesOutput, error)

Send marshals and sends the BatchDetectEntities API request.

type BatchDetectKeyPhrasesInput 

type BatchDetectKeyPhrasesInput struct {

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `min:"1" type:"string" required:"true"`

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes
	// of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrasesRequest

func (BatchDetectKeyPhrasesInput) GoString 

func (s BatchDetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (BatchDetectKeyPhrasesInput) String 

func (s BatchDetectKeyPhrasesInput) String() string

String returns the string representation

func (*BatchDetectKeyPhrasesInput) Validate 

func (s *BatchDetectKeyPhrasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetectKeyPhrasesItemResult 

type BatchDetectKeyPhrasesItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`

	// One or more KeyPhrase objects, one for each key phrase detected in the document.
	KeyPhrases []KeyPhrase `type:"list"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrasesItemResult

func (BatchDetectKeyPhrasesItemResult) GoString 

func (s BatchDetectKeyPhrasesItemResult) GoString() string

GoString returns the string representation

func (BatchDetectKeyPhrasesItemResult) String 

func (s BatchDetectKeyPhrasesItemResult) String() string

String returns the string representation

type BatchDetectKeyPhrasesOutput 

type BatchDetectKeyPhrasesOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []BatchDetectKeyPhrasesItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrasesResponse

func (BatchDetectKeyPhrasesOutput) GoString 

func (s BatchDetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (BatchDetectKeyPhrasesOutput) SDKResponseMetadata 

func (s BatchDetectKeyPhrasesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BatchDetectKeyPhrasesOutput) String 

func (s BatchDetectKeyPhrasesOutput) String() string

String returns the string representation

type BatchDetectKeyPhrasesRequest 

type BatchDetectKeyPhrasesRequest struct {
	*aws.Request
	Input *BatchDetectKeyPhrasesInput
	Copy  func(*BatchDetectKeyPhrasesInput) BatchDetectKeyPhrasesRequest
}

BatchDetectKeyPhrasesRequest is a API request type for the BatchDetectKeyPhrases API operation.

func (BatchDetectKeyPhrasesRequest) Send 

func (r BatchDetectKeyPhrasesRequest) Send() (*BatchDetectKeyPhrasesOutput, error)

Send marshals and sends the BatchDetectKeyPhrases API request.

type BatchDetectSentimentInput 

type BatchDetectSentimentInput struct {

	// The language of the input documents. All documents must be in the same language.
	//
	// LanguageCode is a required field
	LanguageCode *string `min:"1" type:"string" required:"true"`

	// A list containing the text of the input documents. The list can contain a
	// maximum of 25 documents. Each document must contain fewer that 5,000 bytes
	// of UTF-8 encoded characters.
	//
	// TextList is a required field
	TextList []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentimentRequest

func (BatchDetectSentimentInput) GoString 

func (s BatchDetectSentimentInput) GoString() string

GoString returns the string representation

func (BatchDetectSentimentInput) String 

func (s BatchDetectSentimentInput) String() string

String returns the string representation

func (*BatchDetectSentimentInput) Validate 

func (s *BatchDetectSentimentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetectSentimentItemResult 

type BatchDetectSentimentItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`

	// The sentiment detected in the document.
	Sentiment SentimentType `type:"string" enum:"true"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// sentiment detection.
	SentimentScore *SentimentScore `type:"structure"`
	// contains filtered or unexported fields
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentimentItemResult

func (BatchDetectSentimentItemResult) GoString 

func (s BatchDetectSentimentItemResult) GoString() string

GoString returns the string representation

func (BatchDetectSentimentItemResult) String 

func (s BatchDetectSentimentItemResult) String() string

String returns the string representation

type BatchDetectSentimentOutput 

type BatchDetectSentimentOutput struct {

	// A list containing one object for each document that contained an error. The
	// results are sorted in ascending order by the Index field and match the order
	// of the documents in the input list. If there are no errors in the batch,
	// the ErrorList is empty.
	//
	// ErrorList is a required field
	ErrorList []BatchItemError `type:"list" required:"true"`

	// A list of objects containing the results of the operation. The results are
	// sorted in ascending order by the Index field and match the order of the documents
	// in the input list. If all of the documents contain an error, the ResultList
	// is empty.
	//
	// ResultList is a required field
	ResultList []BatchDetectSentimentItemResult `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentimentResponse

func (BatchDetectSentimentOutput) GoString 

func (s BatchDetectSentimentOutput) GoString() string

GoString returns the string representation

func (BatchDetectSentimentOutput) SDKResponseMetadata 

func (s BatchDetectSentimentOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (BatchDetectSentimentOutput) String 

func (s BatchDetectSentimentOutput) String() string

String returns the string representation

type BatchDetectSentimentRequest 

type BatchDetectSentimentRequest struct {
	*aws.Request
	Input *BatchDetectSentimentInput
	Copy  func(*BatchDetectSentimentInput) BatchDetectSentimentRequest
}

BatchDetectSentimentRequest is a API request type for the BatchDetectSentiment API operation.

func (BatchDetectSentimentRequest) Send 

func (r BatchDetectSentimentRequest) Send() (*BatchDetectSentimentOutput, error)

Send marshals and sends the BatchDetectSentiment API request.

type BatchItemError 

type BatchItemError struct {

	// The numeric error code of the error.
	ErrorCode *string `min:"1" type:"string"`

	// A text description of the error.
	ErrorMessage *string `min:"1" type:"string"`

	// The zero-based index of the document in the input list.
	Index *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchItemError

func (BatchItemError) GoString 

func (s BatchItemError) GoString() string

GoString returns the string representation

func (BatchItemError) String 

func (s BatchItemError) String() string

String returns the string representation

type Comprehend 

type Comprehend struct {
	*aws.Client
}

Comprehend provides the API operation methods for making requests to Amazon Comprehend. See this package's package overview docs for details on the service.

Comprehend methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Comprehend

New creates a new instance of the Comprehend client with a config.

Example: 

// Create a Comprehend client from just a config.
svc := comprehend.New(myConfig)

func (*Comprehend) BatchDetectDominantLanguageRequest 

func (c *Comprehend) BatchDetectDominantLanguageRequest(input *BatchDetectDominantLanguageInput) BatchDetectDominantLanguageRequest

BatchDetectDominantLanguageRequest returns a request value for making API operation for Amazon Comprehend.

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html). 

// Example sending a request using the BatchDetectDominantLanguageRequest method.
req := client.BatchDetectDominantLanguageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguage

func (*Comprehend) BatchDetectEntitiesRequest 

func (c *Comprehend) BatchDetectEntitiesRequest(input *BatchDetectEntitiesInput) BatchDetectEntitiesRequest

BatchDetectEntitiesRequest returns a request value for making API operation for Amazon Comprehend.

Inspects the text of a batch of documents and returns information about them. For more information about entities, see how-entities 

// Example sending a request using the BatchDetectEntitiesRequest method.
req := client.BatchDetectEntitiesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntities

func (*Comprehend) BatchDetectKeyPhrasesRequest 

func (c *Comprehend) BatchDetectKeyPhrasesRequest(input *BatchDetectKeyPhrasesInput) BatchDetectKeyPhrasesRequest

BatchDetectKeyPhrasesRequest returns a request value for making API operation for Amazon Comprehend.

Detects the key noun phrases found in a batch of documents. 

// Example sending a request using the BatchDetectKeyPhrasesRequest method.
req := client.BatchDetectKeyPhrasesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases

func (*Comprehend) BatchDetectSentimentRequest 

func (c *Comprehend) BatchDetectSentimentRequest(input *BatchDetectSentimentInput) BatchDetectSentimentRequest

BatchDetectSentimentRequest returns a request value for making API operation for Amazon Comprehend.

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one. 

// Example sending a request using the BatchDetectSentimentRequest method.
req := client.BatchDetectSentimentRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentiment

func (*Comprehend) DescribeTopicsDetectionJobRequest 

func (c *Comprehend) DescribeTopicsDetectionJobRequest(input *DescribeTopicsDetectionJobInput) DescribeTopicsDetectionJobRequest

DescribeTopicsDetectionJobRequest returns a request value for making API operation for Amazon Comprehend.

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job. 

// Example sending a request using the DescribeTopicsDetectionJobRequest method.
req := client.DescribeTopicsDetectionJobRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJob

func (*Comprehend) DetectDominantLanguageRequest 

func (c *Comprehend) DetectDominantLanguageRequest(input *DetectDominantLanguageInput) DetectDominantLanguageRequest

DetectDominantLanguageRequest returns a request value for making API operation for Amazon Comprehend.

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages (http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html). 

// Example sending a request using the DetectDominantLanguageRequest method.
req := client.DetectDominantLanguageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguage

func (*Comprehend) DetectEntitiesRequest 

func (c *Comprehend) DetectEntitiesRequest(input *DetectEntitiesInput) DetectEntitiesRequest

DetectEntitiesRequest returns a request value for making API operation for Amazon Comprehend.

Inspects text for entities, and returns information about them. For more information, about entities, see how-entities. 

// Example sending a request using the DetectEntitiesRequest method.
req := client.DetectEntitiesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntities

func (*Comprehend) DetectKeyPhrasesRequest 

func (c *Comprehend) DetectKeyPhrasesRequest(input *DetectKeyPhrasesInput) DetectKeyPhrasesRequest

DetectKeyPhrasesRequest returns a request value for making API operation for Amazon Comprehend.

Detects the key noun phrases found in the text. 

// Example sending a request using the DetectKeyPhrasesRequest method.
req := client.DetectKeyPhrasesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrases

func (*Comprehend) DetectSentimentRequest 

func (c *Comprehend) DetectSentimentRequest(input *DetectSentimentInput) DetectSentimentRequest

DetectSentimentRequest returns a request value for making API operation for Amazon Comprehend.

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE). 

// Example sending a request using the DetectSentimentRequest method.
req := client.DetectSentimentRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentiment

func (*Comprehend) ListTopicsDetectionJobsRequest 

func (c *Comprehend) ListTopicsDetectionJobsRequest(input *ListTopicsDetectionJobsInput) ListTopicsDetectionJobsRequest

ListTopicsDetectionJobsRequest returns a request value for making API operation for Amazon Comprehend.

Gets a list of the topic detection jobs that you have submitted. 

// Example sending a request using the ListTopicsDetectionJobsRequest method.
req := client.ListTopicsDetectionJobsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobs

func (*Comprehend) StartTopicsDetectionJobRequest 

func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) StartTopicsDetectionJobRequest

StartTopicsDetectionJobRequest returns a request value for making API operation for Amazon Comprehend.

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job. 

// Example sending a request using the StartTopicsDetectionJobRequest method.
req := client.StartTopicsDetectionJobRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob

type DescribeTopicsDetectionJobInput 

type DescribeTopicsDetectionJobInput struct {

	// The identifier assigned by the user to the detection job.
	//
	// JobId is a required field
	JobId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJobRequest

func (DescribeTopicsDetectionJobInput) GoString 

func (s DescribeTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (DescribeTopicsDetectionJobInput) String 

func (s DescribeTopicsDetectionJobInput) String() string

String returns the string representation

func (*DescribeTopicsDetectionJobInput) Validate 

func (s *DescribeTopicsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeTopicsDetectionJobOutput 

type DescribeTopicsDetectionJobOutput struct {

	// The list of properties for the requested job.
	TopicsDetectionJobProperties *TopicsDetectionJobProperties `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeTopicsDetectionJobResponse

func (DescribeTopicsDetectionJobOutput) GoString 

func (s DescribeTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (DescribeTopicsDetectionJobOutput) SDKResponseMetadata 

func (s DescribeTopicsDetectionJobOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeTopicsDetectionJobOutput) String 

func (s DescribeTopicsDetectionJobOutput) String() string

String returns the string representation

type DescribeTopicsDetectionJobRequest 

type DescribeTopicsDetectionJobRequest struct {
	*aws.Request
	Input *DescribeTopicsDetectionJobInput
	Copy  func(*DescribeTopicsDetectionJobInput) DescribeTopicsDetectionJobRequest
}

DescribeTopicsDetectionJobRequest is a API request type for the DescribeTopicsDetectionJob API operation.

func (DescribeTopicsDetectionJobRequest) Send 

func (r DescribeTopicsDetectionJobRequest) Send() (*DescribeTopicsDetectionJobOutput, error)

Send marshals and sends the DescribeTopicsDetectionJob API request.

type DetectDominantLanguageInput 

type DetectDominantLanguageInput struct {

	// A UTF-8 text string. Each string should contain at least 20 characters and
	// must contain fewer that 5,000 bytes of UTF-8 encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguageRequest

func (DetectDominantLanguageInput) GoString 

func (s DetectDominantLanguageInput) GoString() string

GoString returns the string representation

func (DetectDominantLanguageInput) String 

func (s DetectDominantLanguageInput) String() string

String returns the string representation

func (*DetectDominantLanguageInput) Validate 

func (s *DetectDominantLanguageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectDominantLanguageOutput 

type DetectDominantLanguageOutput struct {

	// The languages that Amazon Comprehend detected in the input text. For each
	// language, the response returns the RFC 5646 language code and the level of
	// confidence that Amazon Comprehend has in the accuracy of its inference. For
	// more information about RFC 5646, see Tags for Identifying Languages (https://tools.ietf.org/html/rfc5646)
	// on the IETF Tools web site.
	Languages []DominantLanguage `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguageResponse

func (DetectDominantLanguageOutput) GoString 

func (s DetectDominantLanguageOutput) GoString() string

GoString returns the string representation

func (DetectDominantLanguageOutput) SDKResponseMetadata 

func (s DetectDominantLanguageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DetectDominantLanguageOutput) String 

func (s DetectDominantLanguageOutput) String() string

String returns the string representation

type DetectDominantLanguageRequest 

type DetectDominantLanguageRequest struct {
	*aws.Request
	Input *DetectDominantLanguageInput
	Copy  func(*DetectDominantLanguageInput) DetectDominantLanguageRequest
}

DetectDominantLanguageRequest is a API request type for the DetectDominantLanguage API operation.

func (DetectDominantLanguageRequest) Send 

func (r DetectDominantLanguageRequest) Send() (*DetectDominantLanguageOutput, error)

Send marshals and sends the DetectDominantLanguage API request.

type DetectEntitiesInput 

type DetectEntitiesInput struct {

	// The RFC 5646 language code of the input text. If the request does not specify
	// the language code, the service detects the dominant language. If you specify
	// a language code that the service does not support, it returns UnsupportedLanguageException
	// exception. For more information about RFC 5646, see Tags for Identifying
	// Languages (https://tools.ietf.org/html/rfc5646) on the IETF Tools web site.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest

func (DetectEntitiesInput) GoString 

func (s DetectEntitiesInput) GoString() string

GoString returns the string representation

func (DetectEntitiesInput) String 

func (s DetectEntitiesInput) String() string

String returns the string representation

func (*DetectEntitiesInput) Validate 

func (s *DetectEntitiesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectEntitiesOutput 

type DetectEntitiesOutput struct {

	// A collection of entities identified in the input text. For each entity, the
	// response provides the entity text, entity type, where the entity text begins
	// and ends, and the level of confidence that Amazon Comprehend has in the detection.
	// For a list of entity types, see how-entities.
	Entities []Entity `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesResponse

func (DetectEntitiesOutput) GoString 

func (s DetectEntitiesOutput) GoString() string

GoString returns the string representation

func (DetectEntitiesOutput) SDKResponseMetadata 

func (s DetectEntitiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DetectEntitiesOutput) String 

func (s DetectEntitiesOutput) String() string

String returns the string representation

type DetectEntitiesRequest 

type DetectEntitiesRequest struct {
	*aws.Request
	Input *DetectEntitiesInput
	Copy  func(*DetectEntitiesInput) DetectEntitiesRequest
}

DetectEntitiesRequest is a API request type for the DetectEntities API operation.

func (DetectEntitiesRequest) Send 

func (r DetectEntitiesRequest) Send() (*DetectEntitiesOutput, error)

Send marshals and sends the DetectEntities API request.

type DetectKeyPhrasesInput 

type DetectKeyPhrasesInput struct {

	// The RFC 5646 language code for the input text. If you don't specify a language
	// code, Amazon Comprehend detects the dominant language. If you specify the
	// code for a language that Amazon Comprehend does not support, it returns and
	// UnsupportedLanguageException. For more information about RFC 5646, see Tags
	// for Identifying Languages (https://tools.ietf.org/html/rfc5646) on the IETF
	// Tools web site.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrasesRequest

func (DetectKeyPhrasesInput) GoString 

func (s DetectKeyPhrasesInput) GoString() string

GoString returns the string representation

func (DetectKeyPhrasesInput) String 

func (s DetectKeyPhrasesInput) String() string

String returns the string representation

func (*DetectKeyPhrasesInput) Validate 

func (s *DetectKeyPhrasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectKeyPhrasesOutput 

type DetectKeyPhrasesOutput struct {

	// A collection of key phrases that Amazon Comprehend identified in the input
	// text. For each key phrase, the response provides the text of the key phrase,
	// where the key phrase begins and ends, and the level of confidence that Amazon
	// Comprehend has in the accuracy of the detection.
	KeyPhrases []KeyPhrase `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrasesResponse

func (DetectKeyPhrasesOutput) GoString 

func (s DetectKeyPhrasesOutput) GoString() string

GoString returns the string representation

func (DetectKeyPhrasesOutput) SDKResponseMetadata 

func (s DetectKeyPhrasesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DetectKeyPhrasesOutput) String 

func (s DetectKeyPhrasesOutput) String() string

String returns the string representation

type DetectKeyPhrasesRequest 

type DetectKeyPhrasesRequest struct {
	*aws.Request
	Input *DetectKeyPhrasesInput
	Copy  func(*DetectKeyPhrasesInput) DetectKeyPhrasesRequest
}

DetectKeyPhrasesRequest is a API request type for the DetectKeyPhrases API operation.

func (DetectKeyPhrasesRequest) Send 

func (r DetectKeyPhrasesRequest) Send() (*DetectKeyPhrasesOutput, error)

Send marshals and sends the DetectKeyPhrases API request.

type DetectSentimentInput 

type DetectSentimentInput struct {

	// The RFC 5646 language code for the input text. If you don't specify a language
	// code, Amazon Comprehend detects the dominant language. If you specify the
	// code for a language that Amazon Comprehend does not support, it returns and
	// UnsupportedLanguageException. For more information about RFC 5646, see Tags
	// for Identifying Languages (https://tools.ietf.org/html/rfc5646) on the IETF
	// Tools web site.
	//
	// LanguageCode is a required field
	LanguageCode LanguageCode `type:"string" required:"true" enum:"true"`

	// A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8
	// encoded characters.
	//
	// Text is a required field
	Text *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentimentRequest

func (DetectSentimentInput) GoString 

func (s DetectSentimentInput) GoString() string

GoString returns the string representation

func (DetectSentimentInput) String 

func (s DetectSentimentInput) String() string

String returns the string representation

func (*DetectSentimentInput) Validate 

func (s *DetectSentimentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetectSentimentOutput 

type DetectSentimentOutput struct {

	// The inferred sentiment that Amazon Comprehend has the highest level of confidence
	// in.
	Sentiment SentimentType `type:"string" enum:"true"`

	// An object that lists the sentiments, and their corresponding confidence levels.
	SentimentScore *SentimentScore `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentimentResponse

func (DetectSentimentOutput) GoString 

func (s DetectSentimentOutput) GoString() string

GoString returns the string representation

func (DetectSentimentOutput) SDKResponseMetadata 

func (s DetectSentimentOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DetectSentimentOutput) String 

func (s DetectSentimentOutput) String() string

String returns the string representation

type DetectSentimentRequest 

type DetectSentimentRequest struct {
	*aws.Request
	Input *DetectSentimentInput
	Copy  func(*DetectSentimentInput) DetectSentimentRequest
}

DetectSentimentRequest is a API request type for the DetectSentiment API operation.

func (DetectSentimentRequest) Send 

func (r DetectSentimentRequest) Send() (*DetectSentimentOutput, error)

Send marshals and sends the DetectSentiment API request.

type DominantLanguage 

type DominantLanguage struct {

	// The RFC 5646 language code for the dominant language.
	LanguageCode *string `min:"1" type:"string"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`
	// contains filtered or unexported fields
}

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguage

func (DominantLanguage) GoString 

func (s DominantLanguage) GoString() string

GoString returns the string representation

func (DominantLanguage) String 

func (s DominantLanguage) String() string

String returns the string representation

type Entity 

type Entity struct {

	// A character offset in the input text that shows where the entity begins (the
	// first character is at position 0). The offset returns the position of each
	// UTF-8 code point in the string. A code point is the abstract character from
	// a particular graphical representation. For example, a multi-byte UTF-8 character
	// maps to a single code point.
	BeginOffset *int64 `type:"integer"`

	// A character offset in the input text that shows where the entity ends. The
	// offset returns the position of each UTF-8 code point in the string. A code
	// point is the abstract character from a particular graphical representation.
	// For example, a multi-byte UTF-8 character maps to a single code point.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The text of the entity.
	Text *string `min:"1" type:"string"`

	// The entity's type.
	Type EntityType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Provides information about an entity. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Entity

func (Entity) GoString 

func (s Entity) GoString() string

GoString returns the string representation

func (Entity) String 

func (s Entity) String() string

String returns the string representation

type EntityType 

type EntityType string
const (
	EntityTypePerson         EntityType = "PERSON"
	EntityTypeLocation       EntityType = "LOCATION"
	EntityTypeOrganization   EntityType = "ORGANIZATION"
	EntityTypeCommercialItem EntityType = "COMMERCIAL_ITEM"
	EntityTypeEvent          EntityType = "EVENT"
	EntityTypeDate           EntityType = "DATE"
	EntityTypeQuantity       EntityType = "QUANTITY"
	EntityTypeTitle          EntityType = "TITLE"
	EntityTypeOther          EntityType = "OTHER"
)

Enum values for EntityType

func (EntityType) MarshalValue 

func (enum EntityType) MarshalValue() (string, error)

func (EntityType) MarshalValueBuf 

func (enum EntityType) MarshalValueBuf(b []byte) ([]byte, error)

type InputDataConfig 

type InputDataConfig struct {

	// Specifies how the text in an input file should be processed:
	//
	//    * ONE_DOC_PER_FILE - Each file is considered a separate document. Use
	//    this option when you are processing large documents, such as newspaper
	//    articles or scientific papers.
	//
	//    * ONE_DOC_PER_LINE - Each line in a file is considered a separate document.
	//    Use this option when you are processing many short documents, such as
	//    text messages.
	InputFormat InputFormat `type:"string" enum:"true"`

	// The Amazon S3 URI for the input data. The URI must be in same region as the
	// API endpoint that you are calling. The URI can point to a single input file
	// or it can provide the prefix for a collection of data files.
	//
	// For example, if you use the URI S3://bucketName/prefix, if the prefix is
	// a single file, Amazon Comprehend uses that file as input. If more than one
	// file begins with the prefix, Amazon Comprehend uses all of them as input.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input properties for a topic detection job. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InputDataConfig

func (InputDataConfig) GoString 

func (s InputDataConfig) GoString() string

GoString returns the string representation

func (InputDataConfig) String 

func (s InputDataConfig) String() string

String returns the string representation

func (*InputDataConfig) Validate 

func (s *InputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InputFormat 

type InputFormat string
const (
	InputFormatOneDocPerFile InputFormat = "ONE_DOC_PER_FILE"
	InputFormatOneDocPerLine InputFormat = "ONE_DOC_PER_LINE"
)

Enum values for InputFormat

func (InputFormat) MarshalValue 

func (enum InputFormat) MarshalValue() (string, error)

func (InputFormat) MarshalValueBuf 

func (enum InputFormat) MarshalValueBuf(b []byte) ([]byte, error)

type JobStatus 

type JobStatus string
const (
	JobStatusSubmitted  JobStatus = "SUBMITTED"
	JobStatusInProgress JobStatus = "IN_PROGRESS"
	JobStatusCompleted  JobStatus = "COMPLETED"
	JobStatusFailed     JobStatus = "FAILED"
)

Enum values for JobStatus

func (JobStatus) MarshalValue 

func (enum JobStatus) MarshalValue() (string, error)

func (JobStatus) MarshalValueBuf 

func (enum JobStatus) MarshalValueBuf(b []byte) ([]byte, error)

type KeyPhrase 

type KeyPhrase struct {

	// A character offset in the input text that shows where the key phrase begins
	// (the first character is at position 0). The offset returns the position of
	// each UTF-8 code point in the string. A code point is the abstract character
	// from a particular graphical representation. For example, a multi-byte UTF-8
	// character maps to a single code point.
	BeginOffset *int64 `type:"integer"`

	// A character offset in the input text where the key phrase ends. The offset
	// returns the position of each UTF-8 code point in the string. A code point
	// is the abstract character from a particular graphical representation. For
	// example, a multi-byte UTF-8 character maps to a single code point.
	EndOffset *int64 `type:"integer"`

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float64 `type:"float"`

	// The text of a key noun phrase.
	Text *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes a key noun phrase. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrase

func (KeyPhrase) GoString 

func (s KeyPhrase) GoString() string

GoString returns the string representation

func (KeyPhrase) String 

func (s KeyPhrase) String() string

String returns the string representation

type LanguageCode 

type LanguageCode string
const (
	LanguageCodeEn LanguageCode = "en"
	LanguageCodeEs LanguageCode = "es"
)

Enum values for LanguageCode

func (LanguageCode) MarshalValue 

func (enum LanguageCode) MarshalValue() (string, error)

func (LanguageCode) MarshalValueBuf 

func (enum LanguageCode) MarshalValueBuf(b []byte) ([]byte, error)

type ListTopicsDetectionJobsInput 

type ListTopicsDetectionJobsInput struct {

	// Filters the jobs that are returned. Jobs can be filtered on their name, status,
	// or the date and time that they were submitted. You can set only one filter
	// at a time.
	Filter *TopicsDetectionJobFilter `type:"structure"`

	// The maximum number of results to return in each page.
	MaxResults *int64 `min:"1" type:"integer"`

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobsRequest

func (ListTopicsDetectionJobsInput) GoString 

func (s ListTopicsDetectionJobsInput) GoString() string

GoString returns the string representation

func (ListTopicsDetectionJobsInput) String 

func (s ListTopicsDetectionJobsInput) String() string

String returns the string representation

func (*ListTopicsDetectionJobsInput) Validate 

func (s *ListTopicsDetectionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTopicsDetectionJobsOutput 

type ListTopicsDetectionJobsOutput struct {

	// Identifies the next page of results to return.
	NextToken *string `min:"1" type:"string"`

	// A list containing the properties of each job that is returned.
	TopicsDetectionJobPropertiesList []TopicsDetectionJobProperties `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListTopicsDetectionJobsResponse

func (ListTopicsDetectionJobsOutput) GoString 

func (s ListTopicsDetectionJobsOutput) GoString() string

GoString returns the string representation

func (ListTopicsDetectionJobsOutput) SDKResponseMetadata 

func (s ListTopicsDetectionJobsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTopicsDetectionJobsOutput) String 

func (s ListTopicsDetectionJobsOutput) String() string

String returns the string representation

type ListTopicsDetectionJobsPager 

type ListTopicsDetectionJobsPager struct {
	aws.Pager
}

ListTopicsDetectionJobsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListTopicsDetectionJobsPager) CurrentPage 

func (p *ListTopicsDetectionJobsPager) CurrentPage() *ListTopicsDetectionJobsOutput

type ListTopicsDetectionJobsRequest 

type ListTopicsDetectionJobsRequest struct {
	*aws.Request
	Input *ListTopicsDetectionJobsInput
	Copy  func(*ListTopicsDetectionJobsInput) ListTopicsDetectionJobsRequest
}

ListTopicsDetectionJobsRequest is a API request type for the ListTopicsDetectionJobs API operation.

func (*ListTopicsDetectionJobsRequest) Paginate 

func (p *ListTopicsDetectionJobsRequest) Paginate(opts ...aws.Option) ListTopicsDetectionJobsPager

Paginate pages iterates over the pages of a ListTopicsDetectionJobsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a ListTopicsDetectionJobs operation.
		req := client.ListTopicsDetectionJobsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListTopicsDetectionJobsRequest) Send 

func (r ListTopicsDetectionJobsRequest) Send() (*ListTopicsDetectionJobsOutput, error)

Send marshals and sends the ListTopicsDetectionJobs API request.

type OutputDataConfig 

type OutputDataConfig struct {

	// The Amazon S3 URI where you want to write the output data. The URI must be
	// in the same region as the API endpoint that you are calling.
	//
	// The service creates an output file called output.tar.gz. It is a compressed
	// archive that contains two files, topic-terms.csv that lists the terms associated
	// with each topic, and doc-topics.csv that lists the documents associated with
	// each topic. For more information, see topic-modeling.
	//
	// S3Uri is a required field
	S3Uri *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides configuration parameters for the output of topic detection jobs. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/OutputDataConfig

func (OutputDataConfig) GoString 

func (s OutputDataConfig) GoString() string

GoString returns the string representation

func (OutputDataConfig) String 

func (s OutputDataConfig) String() string

String returns the string representation

func (*OutputDataConfig) Validate 

func (s *OutputDataConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SentimentScore 

type SentimentScore struct {

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the MIXED sentiment.
	Mixed *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEGATIVE sentiment.
	Negative *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEUTRAL sentiment.
	Neutral *float64 `type:"float"`

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the POSITIVE sentiment.
	Positive *float64 `type:"float"`
	// contains filtered or unexported fields
}

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentScore

func (SentimentScore) GoString 

func (s SentimentScore) GoString() string

GoString returns the string representation

func (SentimentScore) String 

func (s SentimentScore) String() string

String returns the string representation

type SentimentType 

type SentimentType string
const (
	SentimentTypePositive SentimentType = "POSITIVE"
	SentimentTypeNegative SentimentType = "NEGATIVE"
	SentimentTypeNeutral  SentimentType = "NEUTRAL"
	SentimentTypeMixed    SentimentType = "MIXED"
)

Enum values for SentimentType

func (SentimentType) MarshalValue 

func (enum SentimentType) MarshalValue() (string, error)

func (SentimentType) MarshalValueBuf 

func (enum SentimentType) MarshalValueBuf(b []byte) ([]byte, error)

type StartTopicsDetectionJobInput 

type StartTopicsDetectionJobInput struct {

	// A unique identifier for the request. If you do not set the client request
	// token, Amazon Comprehend generates one.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that grants Amazon Comprehend read access to your input data.
	//
	// DataAccessRoleArn is a required field
	DataAccessRoleArn *string `type:"string" required:"true"`

	// Specifies the format and location of the input data for the job.
	//
	// InputDataConfig is a required field
	InputDataConfig *InputDataConfig `type:"structure" required:"true"`

	// The identifier of the job.
	JobName *string `min:"1" type:"string"`

	// The number of topics to detect.
	NumberOfTopics *int64 `min:"1" type:"integer"`

	// Specifies where to send the output files.
	//
	// OutputDataConfig is a required field
	OutputDataConfig *OutputDataConfig `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJobRequest

func (StartTopicsDetectionJobInput) GoString 

func (s StartTopicsDetectionJobInput) GoString() string

GoString returns the string representation

func (StartTopicsDetectionJobInput) String 

func (s StartTopicsDetectionJobInput) String() string

String returns the string representation

func (*StartTopicsDetectionJobInput) Validate 

func (s *StartTopicsDetectionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartTopicsDetectionJobOutput 

type StartTopicsDetectionJobOutput struct {

	// The identifier generated for the job. To get the status of the job, use this
	// identifier with the DescribeTopicDetectionJob operation.
	JobId *string `min:"1" type:"string"`

	// The status of the job:
	//
	//    * SUBMITTED - The job has been received and is queued for processing.
	//
	//    * IN_PROGRESS - Amazon Comprehend is processing the job.
	//
	//    * COMPLETED - The job was successfully completed and the output is available.
	//
	//    * FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob
	//    operation.
	JobStatus JobStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJobResponse

func (StartTopicsDetectionJobOutput) GoString 

func (s StartTopicsDetectionJobOutput) GoString() string

GoString returns the string representation

func (StartTopicsDetectionJobOutput) SDKResponseMetadata 

func (s StartTopicsDetectionJobOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (StartTopicsDetectionJobOutput) String 

func (s StartTopicsDetectionJobOutput) String() string

String returns the string representation

type StartTopicsDetectionJobRequest 

type StartTopicsDetectionJobRequest struct {
	*aws.Request
	Input *StartTopicsDetectionJobInput
	Copy  func(*StartTopicsDetectionJobInput) StartTopicsDetectionJobRequest
}

StartTopicsDetectionJobRequest is a API request type for the StartTopicsDetectionJob API operation.

func (StartTopicsDetectionJobRequest) Send 

func (r StartTopicsDetectionJobRequest) Send() (*StartTopicsDetectionJobOutput, error)

Send marshals and sends the StartTopicsDetectionJob API request.

type TopicsDetectionJobFilter 

type TopicsDetectionJobFilter struct {
	JobName *string `min:"1" type:"string"`

	// Filters the list of topic detection jobs based on job status. Returns only
	// jobs with the specified status.
	JobStatus JobStatus `type:"string" enum:"true"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Only returns jobs submitted after the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time `type:"timestamp" timestampFormat:"unix"`

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Only returns jobs submitted before the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeBefore *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information for filtering topic detection jobs. For more information, see . Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TopicsDetectionJobFilter

func (TopicsDetectionJobFilter) GoString 

func (s TopicsDetectionJobFilter) GoString() string

GoString returns the string representation

func (TopicsDetectionJobFilter) String 

func (s TopicsDetectionJobFilter) String() string

String returns the string representation

func (*TopicsDetectionJobFilter) Validate 

func (s *TopicsDetectionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TopicsDetectionJobProperties 

type TopicsDetectionJobProperties struct {

	// The time that the topic detection job was completed.
	EndTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The input data configuration supplied when you created the topic detection
	// job.
	InputDataConfig *InputDataConfig `type:"structure"`

	// The identifier assigned to the topic detection job.
	JobId *string `min:"1" type:"string"`

	// The name of the topic detection job.
	JobName *string `min:"1" type:"string"`

	// The current status of the topic detection job. If the status is Failed, the
	// reason for the failure is shown in the Message field.
	JobStatus JobStatus `type:"string" enum:"true"`

	// A description for the status of a job.
	Message *string `type:"string"`

	// The number of topics to detect supplied when you created the topic detection
	// job. The default is 10.
	NumberOfTopics *int64 `type:"integer"`

	// The output data configuration supplied when you created the topic detection
	// job.
	OutputDataConfig *OutputDataConfig `type:"structure"`

	// The time that the topic detection job was submitted for processing.
	SubmitTime *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Provides information about a topic detection job. Please also see https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TopicsDetectionJobProperties

func (TopicsDetectionJobProperties) GoString 

func (s TopicsDetectionJobProperties) GoString() string

GoString returns the string representation

func (TopicsDetectionJobProperties) String 

func (s TopicsDetectionJobProperties) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.
 Package comprehendiface provides an interface to enable mocking the Amazon Comprehend service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.