Structures

The following structures are available globally.

  • Results of the analysis, organized by feature.

    See more

    Declaration

    Swift

    public struct AnalysisResults : Codable, Equatable

  • API usage information for the request.

    See more

    Declaration

    Swift

    public struct AnalysisResultsUsage : Codable, Equatable

  • The author of the analyzed content.

    See more

    Declaration

    Swift

    public struct Author : Codable, Equatable

  • Categories model.

    See more

    Declaration

    Swift

    public struct CategoriesModel : Codable, Equatable

  • List of categories models.

    See more

    Declaration

    Swift

    public struct CategoriesModelList : Codable, Equatable

  • Returns a hierarchical taxonomy of the content. The top three categories are returned by default. Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, Portuguese, Spanish.

    See more

    Declaration

    Swift

    public struct CategoriesOptions : Codable, Equatable

  • Relevant text that contributed to the categorization.

    See more

    Declaration

    Swift

    public struct CategoriesRelevantText : Codable, Equatable

  • A categorization of the analyzed text.

    See more

    Declaration

    Swift

    public struct CategoriesResult : Codable, Equatable

  • Information that helps to explain what contributed to the categories result.

    See more

    Declaration

    Swift

    public struct CategoriesResultExplanation : Codable, Equatable

  • Classifications model.

    See more

    Declaration

    Swift

    public struct ClassificationsModel : Codable, Equatable

  • List of classifications models.

    See more

    Declaration

    Swift

    public struct ClassificationsModelList : Codable, Equatable

  • Returns text classifications for the content. Supported languages: English only.

    See more

    Declaration

    Swift

    public struct ClassificationsOptions : Codable, Equatable

  • A classification of the analyzed text.

    See more

    Declaration

    Swift

    public struct ClassificationsResult : Codable, Equatable

  • Returns high-level concepts in the content. For example, a research paper about deep learning might return the concept, “Artificial Intelligence” although the term is not mentioned. Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Spanish.

    See more

    Declaration

    Swift

    public struct ConceptsOptions : Codable, Equatable

  • The general concepts referenced or alluded to in the analyzed text.

    See more

    Declaration

    Swift

    public struct ConceptsResult : Codable, Equatable

  • Delete model results.

    See more

    Declaration

    Swift

    public struct DeleteModelResults : Codable, Equatable

  • Disambiguation information for the entity.

    See more

    Declaration

    Swift

    public struct DisambiguationResult : Codable, Equatable

  • Emotion results for the document as a whole.

    See more

    Declaration

    Swift

    public struct DocumentEmotionResults : Codable, Equatable

  • DocumentSentimentResults.

    See more

    Declaration

    Swift

    public struct DocumentSentimentResults : Codable, Equatable

  • Detects anger, disgust, fear, joy, or sadness that is conveyed in the content or by the context around target phrases specified in the targets parameter. You can analyze emotion for detected entities with entities.emotion and for keywords with keywords.emotion. Supported languages: English.

    See more

    Declaration

    Swift

    public struct EmotionOptions : Codable, Equatable

  • The detected anger, disgust, fear, joy, or sadness that is conveyed by the content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text.

    See more

    Declaration

    Swift

    public struct EmotionResult : Codable, Equatable

  • EmotionScores.

    See more

    Declaration

    Swift

    public struct EmotionScores : Codable, Equatable

  • Identifies people, cities, organizations, and other entities in the content. For more information, see Entity types and subtypes. Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish. Arabic, Chinese, and Dutch are supported only through custom models.

    See more

    Declaration

    Swift

    public struct EntitiesOptions : Codable, Equatable

  • The important people, places, geopolitical entities and other types of entities in your content.

    See more

    Declaration

    Swift

    public struct EntitiesResult : Codable, Equatable

  • EntityMention.

    See more

    Declaration

    Swift

    public struct EntityMention : Codable, Equatable

  • FeatureSentimentResults.

    See more

    Declaration

    Swift

    public struct FeatureSentimentResults : Codable, Equatable

  • Analysis features and options.

    See more

    Declaration

    Swift

    public struct Features : Codable, Equatable

  • Webpage metadata, such as the author and the title of the page.

    See more

    Declaration

    Swift

    public struct FeaturesResultsMetadata : Codable, Equatable

  • RSS or ATOM feed found on the webpage.

    See more

    Declaration

    Swift

    public struct Feed : Codable, Equatable

  • Returns important keywords in the content. Supported languages: English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish, Swedish.

    See more

    Declaration

    Swift

    public struct KeywordsOptions : Codable, Equatable

  • The important keywords in the content, organized by relevance.

    See more

    Declaration

    Swift

    public struct KeywordsResult : Codable, Equatable

  • Custom models that are available for entities and relations.

    See more

    Declaration

    Swift

    public struct ListModelsResults : Codable, Equatable

  • ListSentimentModelsResponse.

    See more

    Declaration

    Swift

    public struct ListSentimentModelsResponse : Codable, Equatable

  • Model.

    See more

    Declaration

    Swift

    public struct Model : Codable, Equatable

  • A list of messages describing model training issues when model status is error.

    See more

    Declaration

    Swift

    public struct Notice : Codable, Equatable

  • RelationArgument.

    See more

    Declaration

    Swift

    public struct RelationArgument : Codable, Equatable

  • An entity that corresponds with an argument in a relation.

    See more

    Declaration

    Swift

    public struct RelationEntity : Codable, Equatable

  • Recognizes when two entities are related and identifies the type of relation. For example, an awardedTo relation might connect the entities “Nobel Prize” and “Albert Einstein”. For more information, see Relation types. Supported languages: Arabic, English, German, Japanese, Korean, Spanish. Chinese, Dutch, French, Italian, and Portuguese custom models are also supported.

    See more

    Declaration

    Swift

    public struct RelationsOptions : Codable, Equatable

  • The relations between entities found in the content.

    See more

    Declaration

    Swift

    public struct RelationsResult : Codable, Equatable

  • SemanticRolesEntity.

    See more

    Declaration

    Swift

    public struct SemanticRolesEntity : Codable, Equatable

  • SemanticRolesKeyword.

    See more

    Declaration

    Swift

    public struct SemanticRolesKeyword : Codable, Equatable

  • Parses sentences into subject, action, and object form. Supported languages: English, German, Japanese, Korean, Spanish.

    See more

    Declaration

    Swift

    public struct SemanticRolesOptions : Codable, Equatable

  • The object containing the actions and the objects the actions act upon.

    See more

    Declaration

    Swift

    public struct SemanticRolesResult : Codable, Equatable

  • The extracted action from the sentence.

    See more

    Declaration

    Swift

    public struct SemanticRolesResultAction : Codable, Equatable

  • The extracted object from the sentence.

    See more

    Declaration

    Swift

    public struct SemanticRolesResultObject : Codable, Equatable

  • The extracted subject from the sentence.

    See more

    Declaration

    Swift

    public struct SemanticRolesResultSubject : Codable, Equatable

  • SemanticRolesVerb.

    See more

    Declaration

    Swift

    public struct SemanticRolesVerb : Codable, Equatable

  • SentenceResult.

    See more

    Declaration

    Swift

    public struct SentenceResult : Codable, Equatable

  • SentimentModel.

    See more

    Declaration

    Swift

    public struct SentimentModel : Codable, Equatable

  • Analyzes the general sentiment of your content or the sentiment toward specific target phrases. You can analyze sentiment for detected entities with entities.sentiment and for keywords with keywords.sentiment. Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish.

    See more

    Declaration

    Swift

    public struct SentimentOptions : Codable, Equatable

  • The sentiment of the content.

    See more

    Declaration

    Swift

    public struct SentimentResult : Codable, Equatable

  • (Experimental) Returns a summary of content. Supported languages: English only.

    See more

    Declaration

    Swift

    public struct SummarizationOptions : Codable, Equatable

  • Returns tokens and sentences from the input text.

    See more

    Declaration

    Swift

    public struct SyntaxOptions : Codable, Equatable

  • Tokenization options.

    See more

    Declaration

    Swift

    public struct SyntaxOptionsTokens : Codable, Equatable

  • Tokens and sentences returned from syntax analysis.

    See more

    Declaration

    Swift

    public struct SyntaxResult : Codable, Equatable

  • Emotion results for a specified target.

    See more

    Declaration

    Swift

    public struct TargetedEmotionResults : Codable, Equatable

  • TargetedSentimentResults.

    See more

    Declaration

    Swift

    public struct TargetedSentimentResults : Codable, Equatable

  • TokenResult.

    See more

    Declaration

    Swift

    public struct TokenResult : Codable, Equatable