edu.cmu.sv.dialog_state_tracking.DiscourseAnalysis Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yoda Show documentation
A library that allows rapid prototyping of dialog systems (language understanding, discourse modelling, dialog management, language generation).
There is a newer version: 0.7.0
Show newest version
package edu.cmu.sv.dialog_state_tracking;

import edu.cmu.sv.database.ReferenceResolution;
import edu.cmu.sv.domain.yoda_skeleton.YodaSkeletonOntologyRegistry;
import edu.cmu.sv.semantics.SemanticsModel;
import edu.cmu.sv.system_action.dialog_act.DialogAct;
import edu.cmu.sv.utils.Assert;
import edu.cmu.sv.yoda_environment.YodaEnvironment;
import org.json.simple.JSONObject;

import java.util.LinkedList;
import java.util.Set;

/**
 * Performs and contains results for analysis of the discourse-update-related consequences of a discourse unit
 *
 * Analysis methods may throw AssertException if the type of analysis requested is not applicable
 * modifying the stored analysis result JSONObjects should modify the source discourse unit
 * */
public class DiscourseAnalysis {
    private DiscourseUnit discourseUnit;
    private YodaEnvironment yodaEnvironment;

    public String requestPath;
    public String suggestionPath;
    public JSONObject suggestedContent;
    public JSONObject groundedSuggestionIndividual;
    public Double descriptionMatch;

    public boolean groundMatch;

    public DiscourseAnalysis(DiscourseUnit discourseUnit, YodaEnvironment yodaEnvironment) {
        this.discourseUnit = discourseUnit;
        this.yodaEnvironment = yodaEnvironment;
    }

    public boolean ungroundedByAct(Class ungroundingAction) throws Assert.AssertException {
        if (discourseUnit.initiator.equals("user")){
            Assert.verify(discourseUnit.spokenByMe!= null);
            Assert.verify(discourseUnit.groundTruth != null);
            return discourseUnit.spokenByMe.newGetSlotPathFiller("dialogAct").
                    equals(ungroundingAction.getSimpleName());
        } else { //discourseUnitHypothesis.initiator.equals("system")
            Assert.verify(discourseUnit.spokenByThem!= null);
            Assert.verify(discourseUnit.groundInterpretation != null);
            return discourseUnit.spokenByThem.newGetSlotPathFiller("dialogAct").
                    equals(ungroundingAction.getSimpleName());
        }
    }

    public boolean ungrounded(){
        if (discourseUnit.initiator.equals("user")){
            return !(discourseUnit.spokenByMe == null && discourseUnit.groundTruth == null);
        } else { //discourseUnitHypothesis.initiator.equals("system")
            return !(discourseUnit.spokenByThem == null && discourseUnit.groundInterpretation == null);
        }
    }

    public void analyseValidity() throws Assert.AssertException {
        Assert.verify(discourseUnit.getFromInitiator("verb") != null);
    }

    public void analyseSlotFilling() throws Assert.AssertException {
        analyseValidity();
        if (discourseUnit.initiator.equals("user")){
            Assert.verify(discourseUnit.spokenByMe != null);
            Assert.verify(discourseUnit.groundTruth != null);
            Set suggestionPaths = discourseUnit.getSpokenByMe().
                    findAllPathsToClass(YodaSkeletonOntologyRegistry.suggested.name);
            Assert.verify(suggestionPaths.size() == 0);
            Set requestPaths = discourseUnit.spokenByMe.findAllPathsToClass(YodaSkeletonOntologyRegistry.requested.name);
            Assert.verify(requestPaths.size()==1);
            requestPath = new LinkedList<>(requestPaths).get(0);
        }
    }

    public void analyseSuggestions() throws Assert.AssertException {
        analyseValidity();
        if (discourseUnit.initiator.equals("user")) {
            Set suggestionPaths = discourseUnit.getSpokenByMe().
                    findAllPathsToClass(YodaSkeletonOntologyRegistry.suggested.name);
            Assert.verify(suggestionPaths.size() == 1);
            suggestionPath = new LinkedList<>(suggestionPaths).get(0);
            suggestedContent = (JSONObject) discourseUnit.getSpokenByMe().deepCopy().
                    newGetSlotPathFiller(suggestionPath + "." + YodaSkeletonOntologyRegistry.hasValue.name);
            groundedSuggestionIndividual = (JSONObject) discourseUnit.groundInterpretation.
                    newGetSlotPathFiller(suggestionPath);
        } else { //discourseUnitHypothesis.initiator.equals("system")
            Set suggestionPaths = discourseUnit.getSpokenByThem().
                    findAllPathsToClass(YodaSkeletonOntologyRegistry.suggested.name);
            Assert.verify(suggestionPaths.size() == 1);
            suggestionPath = new LinkedList<>(suggestionPaths).get(0);
            suggestedContent = (JSONObject) discourseUnit.getSpokenByThem().deepCopy().
                    newGetSlotPathFiller(suggestionPath + "." + YodaSkeletonOntologyRegistry.hasValue.name);
            groundedSuggestionIndividual = (JSONObject) discourseUnit.groundTruth.
                    newGetSlotPathFiller(suggestionPath);
        }
        Assert.verify(suggestedContent!=null);
        Assert.verify(groundedSuggestionIndividual!=null);
        descriptionMatch = ReferenceResolution.descriptionMatch(yodaEnvironment,
                groundedSuggestionIndividual, suggestedContent);
        if (descriptionMatch==null)
            descriptionMatch=0.0;
    }

    public void analyseCommonGround() throws Assert.AssertException {
//        System.out.println("analyseCommonGround");
//        System.out.println(discourseUnit.groundTruth);
//        System.out.println(discourseUnit.groundInterpretation);
        analyseValidity();
        if (discourseUnit.groundTruth==null || discourseUnit.groundInterpretation==null) {
            groundMatch = false;
            return;
        }
        groundMatch = SemanticsModel.contentEqual(discourseUnit.groundInterpretation, discourseUnit.groundTruth);
    }

}