View a markdown version of this page

TopicNamedEntity - Amazon Quick
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TopicNamedEntity

A structure that represents a named entity.

Contents

Note

In the following list, the required parameters are described first.

EntityName

The name of the named entity.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

Definition

The definition of a named entity.

Type: Array of NamedEntityDefinition objects

Required: No

EntityDescription

The description of the named entity.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

EntitySynonyms

The other names or aliases for the named entity.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

PresentationOrder

The presentation order of the named entity.

Type: Integer

Required: No

RankOrder

The rank order of the named entity.

Type: Integer

Required: No

SemanticEntityType

The type of named entity that a topic represents.

Type: SemanticEntityType object

Required: No

Sort

The sort configuration of the named entity.

Type: Array of NamedEntitySort objects

Array Members: Maximum number of 1 item.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: