NluEnrichmentEntities

public struct NluEnrichmentEntities : Codable, Equatable

An object speficying the Entities enrichment and related parameters.

  • When true, sentiment analysis of entities will be performed on the specified field.

    Declaration

    Swift

    public var sentiment: Bool?

  • When true, emotion detection of entities will be performed on the specified field.

    Declaration

    Swift

    public var emotion: Bool?

  • The maximum number of entities to extract for each instance of the specified field.

    Declaration

    Swift

    public var limit: Int?

  • When true, the number of mentions of each identified entity is recorded. The default is false.

    Declaration

    Swift

    public var mentions: Bool?

  • When true, the types of mentions for each idetifieid entity is recorded. The default is false.

    Declaration

    Swift

    public var mentionTypes: Bool?

  • When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.

    Declaration

    Swift

    public var sentenceLocations: Bool?

  • The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, or the default public model alchemy.

    Declaration

    Swift

    public var model: String?

  • Initialize a NluEnrichmentEntities with member variables.

    Declaration

    Swift

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

    Parameters

    sentiment

    When true, sentiment analysis of entities will be performed on the specified field.
    emotion

    When true, emotion detection of entities will be performed on the specified field.
    limit

    The maximum number of entities to extract for each instance of the specified field.
    mentions

    When true, the number of mentions of each identified entity is recorded. The default is false.
    mentionTypes

    When true, the types of mentions for each idetifieid entity is recorded. The default is false.
    sentenceLocations

    When true, a list of sentence locations for each instance of each identified entity is recorded. The default is false.
    model

    The enrichement model to use with entity extraction. May be a custom model provided by Watson Knowledge Studio, or the default public model alchemy.

    Return Value

    An initialized NluEnrichmentEntities.