Package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.smartconversations

Interface MachineLearningNLUResult

public interface MachineLearningNLUResult
MachineLearningNLUResult

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    MachineLearningNLUResult.Builder
    Dedicated Builder

  • Method Summary

    Modifier and Type
    Method
    Description
    static MachineLearningNLUResult.Builder
    builder()
    Getting builder
    String
    getIntent()
    The most probable intent of the analyzed text.
    String
    getMessage()
    The message text that was analyzed.
    List<IntentResult>
    getResults()
    An array of JSON objects made up of intent and score pairs, where the score represents the likelihood that the message has the corresponding intent.
    Float
    getScore()
    The likelihood that the assigned intent represents the purpose of the analyzed text.

  • Method Details

    • getMessage

      String getMessage()
      The message text that was analyzed.
      Returns:
      message

    • getResults

      List<IntentResult> getResults()
      An array of JSON objects made up of intent and score pairs, where the score represents the likelihood that the message has the corresponding intent.
      Returns:
      results

    • getIntent

      String getIntent()
      The most probable intent of the analyzed text. For example, chitchat.greeting, chitchat.bye, chitchat.compliment, chitchat.how_are_you, or general.yes_or_agreed.
      Returns:
      intent

    • getScore

      Float getScore()
      The likelihood that the assigned intent represents the purpose of the analyzed text. 1 is the maximum value, representing the highest likelihood that the message text matches the intent, and 0 is the minimum value, representing the lowest likelihood that the message text matches the intent.
      Returns:
      score

    • builder

      static MachineLearningNLUResult.Builder builder()
      Getting builder
      Returns:
      New Builder instance