com.sap.cloud.sdk.services.recastai.userrequest.DialogResults Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of recast-ai Show documentation

Integration of SAP Conversational AI, aka Recast AI (Beta release, still subject to change - up to discontinuation of module).

There is a newer version: 2.28.0

Show newest version

/*
 * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 */

package com.sap.cloud.sdk.services.recastai.userrequest;

import java.util.List;

import javax.annotation.Nullable;

import com.google.common.annotations.Beta;
import com.google.gson.annotations.Expose;
import com.google.gson.annotations.SerializedName;

import lombok.NoArgsConstructor;

/**
 * This class represents the results object as defined by Recast Ai. It contains the analysis of the text, further
 * information regarding the conversation and the response of the chatbot.
 */
@Beta
@NoArgsConstructor
public class DialogResults
{
    @SerializedName( "messages" )
    @Expose
    private final List messages = null;

    @SerializedName( "conversation" )
    @Expose
    private Conversation conversation;

    @SerializedName( "nlp" )
    @Expose
    private Nlp nlp;

    /**
     * Returns the messages..
     * 
     * @return a list with all messages
     */
    @Nullable
    public List getMessages()
    {
        return messages;
    }

    /**
     * Function returns information on the conversation.
     * 
     * @return a conversation object with further details
     */
    @Nullable
    public Conversation getConversation()
    {
        return conversation;
    }

    /**
     * The same as the NLP provided by another API endpoint by Recast.
     * 
     * @return a NLP object with further details on the input.
     */
    @Nullable
    public Nlp getNlp()
    {
        return nlp;
    }
}