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

/**
 * This class represents an intent as identified by Recast.
 */
@Beta
@NoArgsConstructor
public class Intent
{
    @SerializedName( "slug" )
    @Expose
    private String slug;

    @SerializedName( "confidence" )
    @Expose
    private Double confidence;

    @SerializedName( "description" )
    @Expose
    private Object description;

    /**
     * Slug refers to the title of the identified intent.
     * 
     * @return a string with the name as set by the author of the intent
     */
    @Nullable
    public String getSlug()
    {
        return slug;
    }

    /**
     * The confidence desribes the level of confidence racast has in matching this intent with the input
     * 
     * @return returns a double representation between 0 and 1
     */
    @Nullable
    public Double getConfidence()
    {
        return confidence;
    }

    /**
     * The description of the intent, currently always null
     * 
     * @return the description of the intent as set by the author of the intent
     */
    @Nullable
    public Object getDescription()
    {
        return description;
    }
}