EntitiesOptions

public struct EntitiesOptions : 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.

  • Maximum number of entities to return.

    Declaration

    Swift

    public var limit: Int?

  • Set this to true to return locations of entity mentions.

    Declaration

    Swift

    public var mentions: Bool?

  • Enter a custom model ID to override the standard entity detection model.

    Declaration

    Swift

    public var model: String?

  • Set this to true to return sentiment information for detected entities.

    Declaration

    Swift

    public var sentiment: Bool?

  • Set this to true to analyze emotion for detected keywords.

    Declaration

    Swift

    public var emotion: Bool?

  • Initialize a EntitiesOptions with member variables.

    Declaration

    Swift

    public init(
    limit: Int? = nil,
    mentions: Bool? = nil,
    model: String? = nil,
    sentiment: Bool? = nil,
    emotion: Bool? = nil
)

    Parameters

    limit

    Maximum number of entities to return.
    mentions

    Set this to true to return locations of entity mentions.
    model

    Enter a custom model ID to override the standard entity detection model.
    sentiment

    Set this to true to return sentiment information for detected entities.
    emotion

    Set this to true to analyze emotion for detected keywords.

    Return Value

    An initialized EntitiesOptions.