com.sap.cloud.sdk.services.recastai.userrequest.Conversation 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.Map;

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;

/**
 * Representation of a conversation JSON object as sent by Recast.
 */
@Beta
@NoArgsConstructor
public class Conversation
{
    @SerializedName( "id" )
    @Expose
    private String id;

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

    @SerializedName( "memory" )
    @Expose
    private Map memory;

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

    @SerializedName( "skill_occurences" )
    @Expose
    private Integer skillOccurences;

    /**
     * The id of the current conversation
     * 
     * @return a string with the id
     */
    @Nullable
    public String getId()
    {
        return id;
    }

    /**
     * The language of the current conversation
     * 
     * @return a string containing a shortcut of the language
     */
    @Nullable
    public String getLanguage()
    {
        return language;
    }

    /**
     * The memory of your bot for the current conversation
     * 
     * @return a map for which a string serves as a key
     */
    @Nullable
    public Map getMemory()
    {
        return memory;
    }

    /**
     * The slug of the current skill is returned.
     * 
     * @return the identified slug of the skill.
     */
    @Nullable
    public String getSkill()
    {
        return skill;
    }

    /**
     * The slug of the current skill
     * 
     * @return count of the skill occurences in this conversation.
     */
    @Nullable
    public Integer getSkillOccurences()
    {
        return skillOccurences;
    }
}