com.sap.cloud.sdk.services.recastai.userrequest.NlpResponse 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 javax.annotation.Nullable;

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

import lombok.NoArgsConstructor;

/**
 * Represents the outermost wrapper JSON class upon sending a NLP anaylsis request as defined by Recast.
 */
@Beta
@NoArgsConstructor
public class NlpResponse
{
    @SerializedName( "results" )
    @Expose
    private NlpResults results;

    @SerializedName( "message" )
    @Expose
    private String message;

    /**
     * Contains the results, which are all interesting properties of the text
     * 
     * @return an object with details on the NLP anaylsis
     */
    @Nullable
    public NlpResults getResults()
    {
        return results;
    }

    /**
     * The message gives information on the status. One expects a confirmation of the rendering
     * 
     * @return returns a string confirming the successful rendering
     */
    @Nullable
    public String getMessage()
    {
        return message;
    }
}