types

package
v0.28.0 Latest Latest
Warning

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

 Go to latest Published: Oct 26, 2020 License: Apache-2.0 Imports: 3 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchDetectDominantLanguageItemResult 

type BatchDetectDominantLanguageItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// One or more DominantLanguage objects describing the dominant languages in the
	// document.
	Languages []*DominantLanguage
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

type BatchDetectEntitiesItemResult 

type BatchDetectEntitiesItemResult struct {

	// One or more Entity objects, one for each entity detected in the document.
	Entities []*Entity

	// The zero-based index of the document in the input list.
	Index *int32
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

type BatchDetectKeyPhrasesItemResult 

type BatchDetectKeyPhrasesItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// One or more KeyPhrase objects, one for each key phrase detected in the document.
	KeyPhrases []*KeyPhrase
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

type BatchDetectSentimentItemResult 

type BatchDetectSentimentItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// The sentiment detected in the document.
	Sentiment SentimentType

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// sentiment detection.
	SentimentScore *SentimentScore
}

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

type BatchDetectSyntaxItemResult 

type BatchDetectSyntaxItemResult struct {

	// The zero-based index of the document in the input list.
	Index *int32

	// The syntax tokens for the words in the document, one token for each word.
	SyntaxTokens []*SyntaxToken
}

The result of calling the operation. The operation returns one object that is successfully processed by the operation.

type BatchItemError 

type BatchItemError struct {

	// The numeric error code of the error.
	ErrorCode *string

	// A text description of the error.
	ErrorMessage *string

	// The zero-based index of the document in the input list.
	Index *int32
}

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.

type BatchSizeLimitExceededException 

type BatchSizeLimitExceededException struct {
	Message *string
}

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

func (*BatchSizeLimitExceededException) Error 

func (e *BatchSizeLimitExceededException) Error() string

func (*BatchSizeLimitExceededException) ErrorCode 

func (e *BatchSizeLimitExceededException) ErrorCode() string

func (*BatchSizeLimitExceededException) ErrorFault 

func (e *BatchSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*BatchSizeLimitExceededException) ErrorMessage 

func (e *BatchSizeLimitExceededException) ErrorMessage() string

type ClassifierEvaluationMetrics 

type ClassifierEvaluationMetrics struct {

	// The fraction of the labels that were correct recognized. It is computed by
	// dividing the number of labels in the test documents that were correctly
	// recognized by the total number of labels in the test documents.
	Accuracy *float64

	// A measure of how accurate the classifier results are for the test data. It is
	// derived from the Precision and Recall values. The F1Score is the harmonic
	// average of the two scores. The highest score is 1, and the worst score is 0.
	F1Score *float64

	// Indicates the fraction of labels that are incorrectly predicted. Also seen as
	// the fraction of wrong labels compared to the total number of labels. Scores
	// closer to zero are better.
	HammingLoss *float64

	// A measure of how accurate the classifier results are for the test data. It is a
	// combination of the Micro Precision and Micro Recall values. The Micro F1Score is
	// the harmonic mean of the two scores. The highest score is 1, and the worst score
	// is 0.
	MicroF1Score *float64

	// A measure of the usefulness of the recognizer results in the test data. High
	// precision means that the recognizer returned substantially more relevant results
	// than irrelevant ones. Unlike the Precision metric which comes from averaging the
	// precision of all available labels, this is based on the overall score of all
	// precision scores added together.
	MicroPrecision *float64

	// A measure of how complete the classifier results are for the test data. High
	// recall means that the classifier returned most of the relevant results.
	// Specifically, this indicates how many of the correct categories in the text that
	// the model can predict. It is a percentage of correct categories in the text that
	// can found. Instead of averaging the recall scores of all labels (as with
	// Recall), micro Recall is based on the overall score of all recall scores added
	// together.
	MicroRecall *float64

	// A measure of the usefulness of the classifier results in the test data. High
	// precision means that the classifier returned substantially more relevant results
	// than irrelevant ones.
	Precision *float64

	// A measure of how complete the classifier results are for the test data. High
	// recall means that the classifier returned most of the relevant results.
	Recall *float64
}

Describes the result metrics for the test data associated with an documentation classifier.

type ClassifierMetadata 

type ClassifierMetadata struct {

	// Describes the result metrics for the test data associated with an documentation
	// classifier.
	EvaluationMetrics *ClassifierEvaluationMetrics

	// The number of labels in the input data.
	NumberOfLabels *int32

	// The number of documents in the input data that were used to test the classifier.
	// Typically this is 10 to 20 percent of the input documents, up to 10,000
	// documents.
	NumberOfTestDocuments *int32

	// The number of documents in the input data that were used to train the
	// classifier. Typically this is 80 to 90 percent of the input documents.
	NumberOfTrainedDocuments *int32
}

Provides information about a document classifier.

type ConcurrentModificationException 

type ConcurrentModificationException struct {
	Message *string
}

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

func (*ConcurrentModificationException) Error 

func (e *ConcurrentModificationException) Error() string

func (*ConcurrentModificationException) ErrorCode 

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault 

func (e *ConcurrentModificationException) ErrorFault() smithy.ErrorFault

func (*ConcurrentModificationException) ErrorMessage 

func (e *ConcurrentModificationException) ErrorMessage() string

type DocumentClass 

type DocumentClass struct {

	// The name of the class.
	Name *string

	// The confidence score that Amazon Comprehend has this class correctly attributed.
	Score *float32
}

Specifies the class that categorizes the document being analyzed

type DocumentClassificationJobFilter 

type DocumentClassificationJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list based on job status. Returns only jobs with the specified
	// status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

type DocumentClassificationJobProperties 

type DocumentClassificationJobProperties struct {

	// 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 *string

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string

	// The time that the document classification job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the document
	// classification job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the document classification job.
	JobId *string

	// The name that you assigned to the document classification job.
	JobName *string

	// The current status of the document classification job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus JobStatus

	// A description of the status of the job.
	Message *string

	// The output data configuration that you supplied when you created the document
	// classification job.
	OutputDataConfig *OutputDataConfig

	// The time that the document classification job was submitted for processing.
	SubmitTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your document classification job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about a document classification job.

type DocumentClassifierFilter 

type DocumentClassifierFilter struct {

	// Filters the list of classifiers based on status.
	Status ModelStatus

	// Filters the list of classifiers based on the time that the classifier was
	// submitted for processing. Returns only classifiers submitted after the specified
	// time. Classifiers are returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of classifiers based on the time that the classifier was
	// submitted for processing. Returns only classifiers submitted before the
	// specified time. Classifiers are returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

type DocumentClassifierInputDataConfig 

type DocumentClassifierInputDataConfig struct {

	// The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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.
	//
	// This member is required.
	S3Uri *string

	// Indicates the delimiter used to separate each label for training a multi-label
	// classifier. The default delimiter between labels is a pipe (|). You can use a
	// different character as a delimiter (if it's an allowed character) by specifying
	// it under Delimiter for labels. If the training documents use a delimiter other
	// than the default or the delimiter you specify, the labels on that line will be
	// combined to make a single unique label, such as LABELLABELLABEL.
	LabelDelimiter *string
}

The input properties for training a document classifier. For more information on how the input file is formatted, see how-document-classification-training-data.

type DocumentClassifierMode 

type DocumentClassifierMode string
const (
	DocumentClassifierModeMulti_class DocumentClassifierMode = "MULTI_CLASS"
	DocumentClassifierModeMulti_label DocumentClassifierMode = "MULTI_LABEL"
)

Enum values for DocumentClassifierMode

type DocumentClassifierOutputDataConfig 

type DocumentClassifierOutputDataConfig struct {

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt the output results from an analysis job. The KmsKeyId can be one of the
	// following formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//
	// * Amazon Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//
	// * KMS Key Alias: "alias/ExampleAlias"
	//
	//     * ARN of a KMS Key Alias:
	// "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string

	// When you use the OutputDataConfig object while creating a custom classifier, you
	// specify the Amazon S3 location where you want to write the confusion matrix. The
	// URI must be in the same region as the API endpoint that you are calling. The
	// location is used as the prefix for the actual location of this output file. When
	// the custom classifier job is finished, the service creates the output file in a
	// directory specific to the job. The S3Uri field contains the location of the
	// output file, called output.tar.gz. It is a compressed archive that contains the
	// confusion matrix.
	S3Uri *string
}

Provides output results configuration parameters for custom classifier jobs.

type DocumentClassifierProperties 

type DocumentClassifierProperties struct {

	// Information about the document classifier, including the number of documents
	// used for training the classifier, the number of documents used for test the
	// classifier, and an accuracy rating.
	ClassifierMetadata *ClassifierMetadata

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string

	// The Amazon Resource Name (ARN) that identifies the document classifier.
	DocumentClassifierArn *string

	// The time that training the document classifier completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the document
	// classifier for training.
	InputDataConfig *DocumentClassifierInputDataConfig

	// The language code for the language of the documents that the classifier was
	// trained on.
	LanguageCode LanguageCode

	// Additional information about the status of the classifier.
	Message *string

	// Indicates the mode in which the specific classifier was trained. This also
	// indicates the format of input documents and the format of the confusion matrix.
	// Each classifier can only be trained in one mode and this cannot be changed once
	// the classifier is trained.
	Mode DocumentClassifierMode

	// Provides output results configuration parameters for custom classifier jobs.
	OutputDataConfig *DocumentClassifierOutputDataConfig

	// The status of the document classifier. If the status is TRAINED the classifier
	// is ready to use. If the status is FAILED you can see additional information
	// about why the classifier wasn't trained in the Message field.
	Status ModelStatus

	// The time that the document classifier was submitted for training.
	SubmitTime *time.Time

	// The time that training of the document classifier was completed. Indicates the
	// time when the training completes on documentation classifiers. You are billed
	// for the time interval between this time and the value of TrainingStartTime.
	TrainingEndTime *time.Time

	// Indicates the time when the training starts on documentation classifiers. You
	// are billed for the time interval between this time and the value of
	// TrainingEndTime.
	TrainingStartTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom classifier. For more information,
	// see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about a document classifier.

type DocumentLabel 

type DocumentLabel struct {

	// The name of the label.
	Name *string

	// The confidence score that Amazon Comprehend has this label correctly attributed.
	Score *float32
}

Specifies one of the label or labels that categorize the document being analyzed.

type DominantLanguage 

type DominantLanguage struct {

	// The RFC 5646 language code for the dominant language. For more information about
	// RFC 5646, see Tags for Identifying Languages
	// (https://tools.ietf.org/html/rfc5646) on the IETF Tools web site.
	LanguageCode *string

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32
}

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.

type DominantLanguageDetectionJobFilter 

type DominantLanguageDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type DominantLanguageDetectionJobProperties 

type DominantLanguageDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the dominant language detection job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the dominant
	// language detection job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the dominant language detection job.
	JobId *string

	// The name that you assigned to the dominant language detection job.
	JobName *string

	// The current status of the dominant language detection job. If the status is
	// FAILED, the Message field shows the reason for the failure.
	JobStatus JobStatus

	// A description for the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the dominant
	// language detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the dominant language detection job was submitted for processing.
	SubmitTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your dominant language detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about a dominant language detection job.

type EndpointFilter 

type EndpointFilter struct {

	// Specifies a date after which the returned endpoint or endpoints were created.
	CreationTimeAfter *time.Time

	// Specifies a date before which the returned endpoint or endpoints were created.
	CreationTimeBefore *time.Time

	// The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
	ModelArn *string

	// Specifies the status of the endpoint being returned. Possible values are:
	// Creating, Ready, Updating, Deleting, Failed.
	Status EndpointStatus
}

The filter used to determine which endpoints are are returned. You can filter jobs on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

type EndpointProperties 

type EndpointProperties struct {

	// The creation date and time of the endpoint.
	CreationTime *time.Time

	// The number of inference units currently used by the model using this endpoint.
	CurrentInferenceUnits *int32

	// The desired number of inference units to be used by the model using this
	// endpoint. Each inference unit represents of a throughput of 100 characters per
	// second.
	DesiredInferenceUnits *int32

	// The Amazon Resource Number (ARN) of the endpoint.
	EndpointArn *string

	// The date and time that the endpoint was last modified.
	LastModifiedTime *time.Time

	// Specifies a reason for failure in cases of Failed status.
	Message *string

	// The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
	ModelArn *string

	// Specifies the status of the endpoint. Because the endpoint updates and creation
	// are asynchronous, so customers will need to wait for the endpoint to be Ready
	// status before making inference requests.
	Status EndpointStatus
}

Specifies information about the specified endpoint.

type EndpointStatus 

type EndpointStatus string
const (
	EndpointStatusCreating   EndpointStatus = "CREATING"
	EndpointStatusDeleting   EndpointStatus = "DELETING"
	EndpointStatusFailed     EndpointStatus = "FAILED"
	EndpointStatusIn_service EndpointStatus = "IN_SERVICE"
	EndpointStatusUpdating   EndpointStatus = "UPDATING"
)

Enum values for EndpointStatus

type EntitiesDetectionJobFilter 

type EntitiesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type EntitiesDetectionJobProperties 

type EntitiesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the entities detection job completed
	EndTime *time.Time

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string

	// The input data configuration that you supplied when you created the entities
	// detection job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the entities detection job.
	JobId *string

	// The name that you assigned the entities detection job.
	JobName *string

	// The current status of the entities detection job. If the status is FAILED, the
	// Message field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the entities
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the entities detection job was submitted for processing.
	SubmitTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your entity detection job. For more information,
	// see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about an entities detection job.

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 *int32

	// 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 *int32

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32

	// The text of the entity.
	Text *string

	// The entity's type.
	Type EntityType
}

Provides information about an entity.

type EntityRecognizerAnnotations 

type EntityRecognizerAnnotations struct {

	// Specifies the Amazon S3 location where the annotations for an entity recognizer
	// are located. The URI must be in the same region as the API endpoint that you are
	// calling.
	//
	// This member is required.
	S3Uri *string
}

Describes the annotations associated with a entity recognizer.

type EntityRecognizerDocuments 

type EntityRecognizerDocuments struct {

	// Specifies the Amazon S3 location where the training documents for an entity
	// recognizer are located. The URI must be in the same region as the API endpoint
	// that you are calling.
	//
	// This member is required.
	S3Uri *string
}

Describes the training documents submitted with an entity recognizer.

type EntityRecognizerEntityList 

type EntityRecognizerEntityList struct {

	// Specifies the Amazon S3 location where the entity list is located. The URI must
	// be in the same region as the API endpoint that you are calling.
	//
	// This member is required.
	S3Uri *string
}

Describes the entity recognizer submitted with an entity recognizer.

type EntityRecognizerEvaluationMetrics 

type EntityRecognizerEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for the test data. It is
	// derived from the Precision and Recall values. The F1Score is the harmonic
	// average of the two scores. The highest score is 1, and the worst score is 0.
	F1Score *float64

	// A measure of the usefulness of the recognizer results in the test data. High
	// precision means that the recognizer returned substantially more relevant results
	// than irrelevant ones.
	Precision *float64

	// A measure of how complete the recognizer results are for the test data. High
	// recall means that the recognizer returned most of the relevant results.
	Recall *float64
}

Detailed information about the accuracy of an entity recognizer.

type EntityRecognizerFilter 

type EntityRecognizerFilter struct {

	// The status of an entity recognizer.
	Status ModelStatus

	// Filters the list of entities based on the time that the list was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeAfter *time.Time

	// Filters the list of entities based on the time that the list was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>

type EntityRecognizerInputDataConfig 

type EntityRecognizerInputDataConfig struct {

	// S3 location of the documents folder for an entity recognizer
	//
	// This member is required.
	Documents *EntityRecognizerDocuments

	// The entity types in the input data for an entity recognizer. A maximum of 12
	// entity types can be used at one time to train an entity recognizer.
	//
	// This member is required.
	EntityTypes []*EntityTypesListItem

	// S3 location of the annotations file for an entity recognizer.
	Annotations *EntityRecognizerAnnotations

	// S3 location of the entity list for an entity recognizer.
	EntityList *EntityRecognizerEntityList
}

Specifies the format and location of the input data.

type EntityRecognizerMetadata 

type EntityRecognizerMetadata struct {

	// Entity types from the metadata of an entity recognizer.
	EntityTypes []*EntityRecognizerMetadataEntityTypesListItem

	// Detailed information about the accuracy of an entity recognizer.
	EvaluationMetrics *EntityRecognizerEvaluationMetrics

	// The number of documents in the input data that were used to test the entity
	// recognizer. Typically this is 10 to 20 percent of the input documents.
	NumberOfTestDocuments *int32

	// The number of documents in the input data that were used to train the entity
	// recognizer. Typically this is 80 to 90 percent of the input documents.
	NumberOfTrainedDocuments *int32
}

Detailed information about an entity recognizer.

type EntityRecognizerMetadataEntityTypesListItem 

type EntityRecognizerMetadataEntityTypesListItem struct {

	// Detailed information about the accuracy of the entity recognizer for a specific
	// item on the list of entity types.
	EvaluationMetrics *EntityTypesEvaluationMetrics

	// Indicates the number of times the given entity type was seen in the training
	// data.
	NumberOfTrainMentions *int32

	// Type of entity from the list of entity types in the metadata of an entity
	// recognizer.
	Type *string
}

Individual item from the list of entity types in the metadata of an entity recognizer.

type EntityRecognizerProperties 

type EntityRecognizerProperties struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your input data.
	DataAccessRoleArn *string

	// The time that the recognizer creation completed.
	EndTime *time.Time

	// The Amazon Resource Name (ARN) that identifies the entity recognizer.
	EntityRecognizerArn *string

	// The input data properties of an entity recognizer.
	InputDataConfig *EntityRecognizerInputDataConfig

	// The language of the input documents. All documents must be in the same language.
	// Only English ("en") is currently supported.
	LanguageCode LanguageCode

	// A description of the status of the recognizer.
	Message *string

	// Provides information about an entity recognizer.
	RecognizerMetadata *EntityRecognizerMetadata

	// Provides the status of the entity recognizer.
	Status ModelStatus

	// The time that the recognizer was submitted for processing.
	SubmitTime *time.Time

	// The time that training of the entity recognizer was completed.
	TrainingEndTime *time.Time

	// The time that training of the entity recognizer started.
	TrainingStartTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your custom entity recognizer. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Describes information about an entity recognizer.

type EntityType 

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

Enum values for EntityType

type EntityTypesEvaluationMetrics 

type EntityTypesEvaluationMetrics struct {

	// A measure of how accurate the recognizer results are for for a specific entity
	// type in the test data. It is derived from the Precision and Recall values. The
	// F1Score is the harmonic average of the two scores. The highest score is 1, and
	// the worst score is 0.
	F1Score *float64

	// A measure of the usefulness of the recognizer results for a specific entity type
	// in the test data. High precision means that the recognizer returned
	// substantially more relevant results than irrelevant ones.
	Precision *float64

	// A measure of how complete the recognizer results are for a specific entity type
	// in the test data. High recall means that the recognizer returned most of the
	// relevant results.
	Recall *float64
}

Detailed information about the accuracy of an entity recognizer for a specific entity type.

type EntityTypesListItem 

type EntityTypesListItem struct {

	// Entity type of an item on an entity type list.
	//
	// This member is required.
	Type *string
}

Information about an individual item on a list of entity types.

type InputDataConfig 

type InputDataConfig struct {

	// 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.
	//
	// This member is required.
	S3Uri *string

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

The input properties for a topic detection job.

type InputFormat 

type InputFormat string
const (
	InputFormatOne_doc_per_file InputFormat = "ONE_DOC_PER_FILE"
	InputFormatOne_doc_per_line InputFormat = "ONE_DOC_PER_LINE"
)

Enum values for InputFormat

type InternalServerException 

type InternalServerException struct {
	Message *string
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidFilterException 

type InvalidFilterException struct {
	Message *string
}

The filter specified for the operation is invalid. Specify a different filter.

func (*InvalidFilterException) Error 

func (e *InvalidFilterException) Error() string

func (*InvalidFilterException) ErrorCode 

func (e *InvalidFilterException) ErrorCode() string

func (*InvalidFilterException) ErrorFault 

func (e *InvalidFilterException) ErrorFault() smithy.ErrorFault

func (*InvalidFilterException) ErrorMessage 

func (e *InvalidFilterException) ErrorMessage() string

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string
}

The request is invalid.

func (*InvalidRequestException) Error 

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode 

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault 

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage 

func (e *InvalidRequestException) ErrorMessage() string

type JobNotFoundException 

type JobNotFoundException struct {
	Message *string
}

The specified job was not found. Check the job ID and try again.

func (*JobNotFoundException) Error 

func (e *JobNotFoundException) Error() string

func (*JobNotFoundException) ErrorCode 

func (e *JobNotFoundException) ErrorCode() string

func (*JobNotFoundException) ErrorFault 

func (e *JobNotFoundException) ErrorFault() smithy.ErrorFault

func (*JobNotFoundException) ErrorMessage 

func (e *JobNotFoundException) ErrorMessage() string

type JobStatus 

type JobStatus string
const (
	JobStatusSubmitted      JobStatus = "SUBMITTED"
	JobStatusIn_progress    JobStatus = "IN_PROGRESS"
	JobStatusCompleted      JobStatus = "COMPLETED"
	JobStatusFailed         JobStatus = "FAILED"
	JobStatusStop_requested JobStatus = "STOP_REQUESTED"
	JobStatusStopped        JobStatus = "STOPPED"
)

Enum values for JobStatus

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 *int32

	// 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 *int32

	// The level of confidence that Amazon Comprehend has in the accuracy of the
	// detection.
	Score *float32

	// The text of a key noun phrase.
	Text *string
}

Describes a key noun phrase.

type KeyPhrasesDetectionJobFilter 

type KeyPhrasesDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type KeyPhrasesDetectionJobProperties 

type KeyPhrasesDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the key phrases detection job completed.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the key phrases
	// detection job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the key phrases detection job.
	JobId *string

	// The name that you assigned the key phrases detection job.
	JobName *string

	// The current status of the key phrases detection job. If the status is FAILED,
	// the Message field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the key phrases
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the key phrases detection job was submitted for processing.
	SubmitTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your key phrases detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about a key phrases detection job.

type KmsKeyValidationException 

type KmsKeyValidationException struct {
	Message *string
}

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

func (*KmsKeyValidationException) Error 

func (e *KmsKeyValidationException) Error() string

func (*KmsKeyValidationException) ErrorCode 

func (e *KmsKeyValidationException) ErrorCode() string

func (*KmsKeyValidationException) ErrorFault 

func (e *KmsKeyValidationException) ErrorFault() smithy.ErrorFault

func (*KmsKeyValidationException) ErrorMessage 

func (e *KmsKeyValidationException) ErrorMessage() string

type LanguageCode 

type LanguageCode string
const (
	LanguageCodeEn    LanguageCode = "en"
	LanguageCodeEs    LanguageCode = "es"
	LanguageCodeFr    LanguageCode = "fr"
	LanguageCodeDe    LanguageCode = "de"
	LanguageCodeIt    LanguageCode = "it"
	LanguageCodePt    LanguageCode = "pt"
	LanguageCodeAr    LanguageCode = "ar"
	LanguageCodeHi    LanguageCode = "hi"
	LanguageCodeJa    LanguageCode = "ja"
	LanguageCodeKo    LanguageCode = "ko"
	LanguageCodeZh    LanguageCode = "zh"
	LanguageCodeZh_tw LanguageCode = "zh-TW"
)

Enum values for LanguageCode

type ModelStatus 

type ModelStatus string
const (
	ModelStatusSubmitted      ModelStatus = "SUBMITTED"
	ModelStatusTraining       ModelStatus = "TRAINING"
	ModelStatusDeleting       ModelStatus = "DELETING"
	ModelStatusStop_requested ModelStatus = "STOP_REQUESTED"
	ModelStatusStopped        ModelStatus = "STOPPED"
	ModelStatusIn_error       ModelStatus = "IN_ERROR"
	ModelStatusTrained        ModelStatus = "TRAINED"
)

Enum values for ModelStatus

type OutputDataConfig 

type OutputDataConfig struct {

	// When you use the OutputDataConfig object with asynchronous operations, you
	// specify the Amazon S3 location 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
	// location is used as the prefix for the actual location of the output file. When
	// the topic detection job is finished, the service creates an output file in a
	// directory specific to the job. The S3Uri field contains the location of the
	// output file, called output.tar.gz. It is a compressed archive that contains the
	// ouput of the operation.
	//
	// This member is required.
	S3Uri *string

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt the output results from an analysis job. The KmsKeyId can be one of the
	// following formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//
	// * Amazon Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//
	// * KMS Key Alias: "alias/ExampleAlias"
	//
	//     * ARN of a KMS Key Alias:
	// "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	KmsKeyId *string
}

Provides configuration parameters for the output of topic detection jobs.

type PartOfSpeechTag 

type PartOfSpeechTag struct {

	// The confidence that Amazon Comprehend has that the part of speech was correctly
	// identified.
	Score *float32

	// Identifies the part of speech that the token represents.
	Tag PartOfSpeechTagType
}

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

type PartOfSpeechTagType 

type PartOfSpeechTagType string
const (
	PartOfSpeechTagTypeAdj   PartOfSpeechTagType = "ADJ"
	PartOfSpeechTagTypeAdp   PartOfSpeechTagType = "ADP"
	PartOfSpeechTagTypeAdv   PartOfSpeechTagType = "ADV"
	PartOfSpeechTagTypeAux   PartOfSpeechTagType = "AUX"
	PartOfSpeechTagTypeConj  PartOfSpeechTagType = "CONJ"
	PartOfSpeechTagTypeCconj PartOfSpeechTagType = "CCONJ"
	PartOfSpeechTagTypeDet   PartOfSpeechTagType = "DET"
	PartOfSpeechTagTypeIntj  PartOfSpeechTagType = "INTJ"
	PartOfSpeechTagTypeNoun  PartOfSpeechTagType = "NOUN"
	PartOfSpeechTagTypeNum   PartOfSpeechTagType = "NUM"
	PartOfSpeechTagTypeO     PartOfSpeechTagType = "O"
	PartOfSpeechTagTypePart  PartOfSpeechTagType = "PART"
	PartOfSpeechTagTypePron  PartOfSpeechTagType = "PRON"
	PartOfSpeechTagTypePropn PartOfSpeechTagType = "PROPN"
	PartOfSpeechTagTypePunct PartOfSpeechTagType = "PUNCT"
	PartOfSpeechTagTypeSconj PartOfSpeechTagType = "SCONJ"
	PartOfSpeechTagTypeSym   PartOfSpeechTagType = "SYM"
	PartOfSpeechTagTypeVerb  PartOfSpeechTagType = "VERB"
)

Enum values for PartOfSpeechTagType

type ResourceInUseException 

type ResourceInUseException struct {
	Message *string
}

The specified resource name is already in use. Use a different name and try your request again.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

func (e *ResourceInUseException) ErrorFault() smithy.ErrorFault

func (*ResourceInUseException) ErrorMessage 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	Message *string
}

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

func (*ResourceLimitExceededException) Error 

func (e *ResourceLimitExceededException) Error() string

func (*ResourceLimitExceededException) ErrorCode 

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault 

func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceLimitExceededException) ErrorMessage 

func (e *ResourceLimitExceededException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string
}

The specified resource ARN was not found. Check the ARN and try your request again.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceUnavailableException 

type ResourceUnavailableException struct {
	Message *string
}

The specified resource is not available. Check the resource and try your request again.

func (*ResourceUnavailableException) Error 

func (e *ResourceUnavailableException) Error() string

func (*ResourceUnavailableException) ErrorCode 

func (e *ResourceUnavailableException) ErrorCode() string

func (*ResourceUnavailableException) ErrorFault 

func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ResourceUnavailableException) ErrorMessage 

func (e *ResourceUnavailableException) ErrorMessage() string

type SentimentDetectionJobFilter 

type SentimentDetectionJobFilter struct {

	// Filters on the name of the job.
	JobName *string

	// Filters the list of jobs based on job status. Returns only jobs with the
	// specified status.
	JobStatus JobStatus

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted after the specified time. Jobs are
	// returned in descending order, newest to oldest.
	SubmitTimeAfter *time.Time

	// Filters the list of jobs based on the time that the job was submitted for
	// processing. Returns only jobs submitted before the specified time. Jobs are
	// returned in ascending order, oldest to newest.
	SubmitTimeBefore *time.Time
}

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

type SentimentDetectionJobProperties 

type SentimentDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your
	// input data.
	DataAccessRoleArn *string

	// The time that the sentiment detection job ended.
	EndTime *time.Time

	// The input data configuration that you supplied when you created the sentiment
	// detection job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the sentiment detection job.
	JobId *string

	// The name that you assigned to the sentiment detection job
	JobName *string

	// The current status of the sentiment detection job. If the status is FAILED, the
	// Messages field shows the reason for the failure.
	JobStatus JobStatus

	// The language code of the input documents.
	LanguageCode LanguageCode

	// A description of the status of a job.
	Message *string

	// The output data configuration that you supplied when you created the sentiment
	// detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the sentiment detection job was submitted for processing.
	SubmitTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your sentiment detection job. For more
	// information, see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about a sentiment detection job.

type SentimentScore 

type SentimentScore struct {

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the MIXED sentiment.
	Mixed *float32

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEGATIVE sentiment.
	Negative *float32

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the NEUTRAL sentiment.
	Neutral *float32

	// The level of confidence that Amazon Comprehend has in the accuracy of its
	// detection of the POSITIVE sentiment.
	Positive *float32
}

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

type SentimentType 

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

Enum values for SentimentType

type SyntaxLanguageCode 

type SyntaxLanguageCode string
const (
	SyntaxLanguageCodeEn SyntaxLanguageCode = "en"
	SyntaxLanguageCodeEs SyntaxLanguageCode = "es"
	SyntaxLanguageCodeFr SyntaxLanguageCode = "fr"
	SyntaxLanguageCodeDe SyntaxLanguageCode = "de"
	SyntaxLanguageCodeIt SyntaxLanguageCode = "it"
	SyntaxLanguageCodePt SyntaxLanguageCode = "pt"
)

Enum values for SyntaxLanguageCode

type SyntaxToken 

type SyntaxToken struct {

	// The zero-based offset from the beginning of the source text to the first
	// character in the word.
	BeginOffset *int32

	// The zero-based offset from the beginning of the source text to the last
	// character in the word.
	EndOffset *int32

	// Provides the part of speech label and the confidence level that Amazon
	// Comprehend has that the part of speech was correctly identified. For more
	// information, see how-syntax.
	PartOfSpeech *PartOfSpeechTag

	// The word that was recognized in the source text.
	Text *string

	// A unique identifier for a token.
	TokenId *int32
}

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

type Tag 

type Tag struct {

	// The initial part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the key portion of the pair, with
	// multiple possible values such as “sales,” “legal,” and “administration.”
	//
	// This member is required.
	Key *string

	// The second part of a key-value pair that forms a tag associated with a given
	// resource. For instance, if you want to show which resources are used by which
	// departments, you might use “Department” as the initial (key) portion of the
	// pair, with a value of “sales” to indicate the sales department.
	Value *string
}

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

type TextSizeLimitExceededException 

type TextSizeLimitExceededException struct {
	Message *string
}

The size of the input text exceeds the limit. Use a smaller document.

func (*TextSizeLimitExceededException) Error 

func (e *TextSizeLimitExceededException) Error() string

func (*TextSizeLimitExceededException) ErrorCode 

func (e *TextSizeLimitExceededException) ErrorCode() string

func (*TextSizeLimitExceededException) ErrorFault 

func (e *TextSizeLimitExceededException) ErrorFault() smithy.ErrorFault

func (*TextSizeLimitExceededException) ErrorMessage 

func (e *TextSizeLimitExceededException) ErrorMessage() string

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string
}

The number of requests exceeds the limit. Resubmit your request later.

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type TooManyTagKeysException 

type TooManyTagKeysException struct {
	Message *string
}

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

func (*TooManyTagKeysException) Error 

func (e *TooManyTagKeysException) Error() string

func (*TooManyTagKeysException) ErrorCode 

func (e *TooManyTagKeysException) ErrorCode() string

func (*TooManyTagKeysException) ErrorFault 

func (e *TooManyTagKeysException) ErrorFault() smithy.ErrorFault

func (*TooManyTagKeysException) ErrorMessage 

func (e *TooManyTagKeysException) ErrorMessage() string

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string
}

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

func (*TooManyTagsException) Error 

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode 

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault 

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage 

func (e *TooManyTagsException) ErrorMessage() string

type TopicsDetectionJobFilter 

type TopicsDetectionJobFilter struct {

	//
	JobName *string

	// Filters the list of topic detection jobs based on job status. Returns only jobs
	// with the specified status.
	JobStatus JobStatus

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

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

Provides information for filtering topic detection jobs. For more information, see .

type TopicsDetectionJobProperties 

type TopicsDetectionJobProperties struct {

	// The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role
	// that grants Amazon Comprehend read access to your job data.
	DataAccessRoleArn *string

	// The time that the topic detection job was completed.
	EndTime *time.Time

	// The input data configuration supplied when you created the topic detection job.
	InputDataConfig *InputDataConfig

	// The identifier assigned to the topic detection job.
	JobId *string

	// The name of the topic detection job.
	JobName *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

	// A description for the status of a job.
	Message *string

	// The number of topics to detect supplied when you created the topic detection
	// job. The default is 10.
	NumberOfTopics *int32

	// The output data configuration supplied when you created the topic detection job.
	OutputDataConfig *OutputDataConfig

	// The time that the topic detection job was submitted for processing.
	SubmitTime *time.Time

	// ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to
	// encrypt data on the storage volume attached to the ML compute instance(s) that
	// process the analysis job. The VolumeKmsKeyId can be either of the following
	// formats:
	//
	//     * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
	//
	//     * Amazon
	// Resource Name (ARN) of a KMS Key:
	// "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	VolumeKmsKeyId *string

	// Configuration parameters for a private Virtual Private Cloud (VPC) containing
	// the resources you are using for your topic detection job. For more information,
	// see Amazon VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).
	VpcConfig *VpcConfig
}

Provides information about a topic detection job.

type UnsupportedLanguageException 

type UnsupportedLanguageException struct {
	Message *string
}

Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-languages.

func (*UnsupportedLanguageException) Error 

func (e *UnsupportedLanguageException) Error() string

func (*UnsupportedLanguageException) ErrorCode 

func (e *UnsupportedLanguageException) ErrorCode() string

func (*UnsupportedLanguageException) ErrorFault 

func (e *UnsupportedLanguageException) ErrorFault() smithy.ErrorFault

func (*UnsupportedLanguageException) ErrorMessage 

func (e *UnsupportedLanguageException) ErrorMessage() string

type VpcConfig 

type VpcConfig struct {

	// The ID number for a security group on an instance of your private VPC. Security
	// groups on your VPC function serve as a virtual firewall to control inbound and
	// outbound traffic and provides security for the resources that you’ll be
	// accessing on the VPC. This ID number is preceded by "sg-", for instance:
	// "sg-03b388029b0a285ea". For more information, see Security Groups for your VPC
	// (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html).
	//
	// This member is required.
	SecurityGroupIds []*string

	// The ID for each subnet being used in your private VPC. This subnet is a subset
	// of the a range of IPv4 addresses used by the VPC and is specific to a given
	// availability zone in the VPC’s region. This ID number is preceded by "subnet-",
	// for instance: "subnet-04ccf456919e69055". For more information, see VPCs and
	// Subnets (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).
	//
	// This member is required.
	Subnets []*string
}

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For For more information, see Amazon VPC (https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

Source Files

View all Source files

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.