1190

pending completion

Build # 1190

Build Type

Pull #281

travis-ci-com

Committed by

web-flow

Commit Message

Merge 3d867e7d8 into 2be1d2787

Pull Request Pull Request #281: minor tweaks to improve agent response

Run Details

6756 of 12551 branches covered (53.83%)

Branch coverage included in aggregate %.

6 of 6 new or added lines in 2 files covered. (100.0%)

15 existing lines in 7 files now uncovered.

15466 of 24203 relevant lines covered (63.9%)

1219694.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

65.25

/languages/thingtalk/dialogue_acts/recommendation.js

// -*- mode: js; indent-tabs-mode: nil; js-basic-offset: 4 -*-
//
// This file is part of Genie
//
// Copyright 2020 The Board of Trustees of the Leland Stanford Junior University
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: Giovanni Campagna <gcampagn@cs.stanford.edu>
"use strict";

const assert = require('assert');

const ThingTalk = require('thingtalk');
const Ast = ThingTalk.Ast;

const C = require('../ast_manip');

const { SlotBag, checkAndAddSlot } = require('../slot_bag');
const {
    makeAgentReply,
    makeSimpleState,
    addActionParam,
    addNewItem,
} = require('../state_manip');
const {
    isInfoPhraseCompatibleWithResult,
    findChainParam
} = require('./common');
const {
    refineFilterToAnswerQuestionOrChangeFilter,
    combinePreambleAndRequest,
    proposalReply
} = require('./refinement-helpers');
const {
    checkInfoPhrase
} = require('./results');


function makeActionRecommendation(ctx, action) {
    assert(action instanceof Ast.Invocation);

    const results = ctx.results;
    assert(results.length > 0);

    const topResult = results[0];
    const id = topResult.value.id;
    if (!id)
        return null;

    if (action.in_params.length !== 1)
        return null;

    for (let param of action.in_params) {
        if (param.value.equals(id))
            return { topResult, info: null, action };
    }

    return null;
}

function makeRecommendation(ctx, name) {
    const results = ctx.results;
    assert(results.length > 0);

    const topResult = results[0];
    const id = topResult.value.id;

    if (!id || !id.equals(name))
        return null;

    return { topResult, ctx, info: null, action: ctx.nextInfo && ctx.nextInfo.isAction ? C.getInvocation(ctx.next) : null };
}

function makeThingpediaRecommendation(ctx, info) {
    const results = ctx.results;
    assert(results.length > 0);

    const topResult = results[0];
    if (!topResult.value.id)
        return null;

    if (!isInfoPhraseCompatibleWithResult(topResult, info))
        return null;

    return { topResult, ctx, info, action: ctx.nextInfo && ctx.nextInfo.isAction ? C.getInvocation(ctx.next) : null };
}


function checkRecommendation({ topResult, action: nextAction }, info) {
    assert(info instanceof SlotBag);
    if (!topResult.value.id)
        return null;

    const resultType = topResult.value.id.getType();
    const idType = info.schema.getArgType('id');
    if (!idType || !idType.equals(resultType))
        return null;

    if (!isInfoPhraseCompatibleWithResult(topResult, info))
        return null;

    return { topResult, info, action: nextAction };
}

function checkActionForRecommendation({ topResult, info, action: nextAction }, action) {
    if (!topResult.value.id)
        return null;
    const resultType = topResult.value.id.getType();

    if (nextAction !== null) {
        if (!C.isSameFunction(nextAction.schema, action.schema))
            return null;
    }

    if (!C.hasArgumentOfType(action, resultType))
        return null;

    return { topResult, info, action };
}

// make a recommendation that looks like an answer, that is, "so and so is a ..."
function makeAnswerStyleRecommendation({ topResult, ctx, action }, filter) {
    let info = new SlotBag(ctx.currentFunctionSchema);
    info = checkAndAddSlot(info, filter);
    if (info === null)
        return null;
    info = checkInfoPhrase(ctx, info);
    if (info === null)
        return null;

    return checkRecommendation({ topResult, action }, info);
}


function makeDisplayResult(ctx, info) {
    const results = ctx.results;
    assert(results.length > 0);
    const topResult = results[0];

    if (ctx.currentFunctionSchema.is_list)
        return null;
    if (!isInfoPhraseCompatibleWithResult(topResult, info))
        return null;
    info = checkInfoPhrase(ctx, info);
    if (info === null)
        return null;

    return { topResult, ctx, info, action: ctx.nextInfo && ctx.nextInfo.isAction ? C.getInvocation(ctx.next) : null, hasAnythingElse: false };
}

function combineDisplayResult(proposal, newInfo) {
    const { ctx, info:oldInfo } = proposal;
    const results = ctx.results;
    assert(results.length > 0);
    const topResult = results[0];
    assert (isInfoPhraseCompatibleWithResult(topResult, newInfo));

    newInfo = SlotBag.merge(oldInfo, newInfo);
    if (newInfo === null)
        return null;

    const newProposal = {};
    Object.assign(newProposal, proposal);
    newProposal.info = newInfo;
    return newProposal;
}

function makeRecommendationReply(ctx, proposal) {
    const { topResult, action, hasLearnMore } = proposal;
    const options = {};
    if (action || hasLearnMore)
        options.end = false;
    if (action === null) {
        return makeAgentReply(ctx, makeSimpleState(ctx, 'sys_recommend_one', null), proposal, null, options);
    } else {
        const chainParam = findChainParam(topResult, action);
        if (!chainParam)
            return null;
        return makeAgentReply(ctx, addActionParam(ctx, 'sys_recommend_one', action, chainParam, topResult.value.id, 'proposed'),
            proposal, null, options);
    }
}

function makeDisplayResultReply(ctx, proposal) {
    const { action, hasAnythingElse } = proposal;
    const options = {};
    if (action || hasAnythingElse)
        options.end = false;
    return makeAgentReply(ctx, makeSimpleState(ctx, 'sys_display_result', null), proposal, null, options);
}

function negativeRecommendationReply(ctx, [preamble, request]) {
    const proposal = ctx.aux;
    const { topResult, info, } = proposal;
    const proposalType = topResult.value.id.getType();
    request = combinePreambleAndRequest(preamble, request, info, proposalType);
    if (request === null)
        return null;
    return proposalReply(ctx, request, refineFilterToAnswerQuestionOrChangeFilter);
}

function positiveRecommendationReply(ctx, acceptedAction, name) {
    const proposal = ctx.aux;
    const { topResult, action: actionProposal } = proposal;

    if (acceptedAction === null) {
        // if the user did not give an action earlier, and no action
        // was proposed by the agent right now, the flow is roughly
        //
        // U: hello i am looking for a restaurant
        // A: how about the ... ?
        // U: sure I like that
        //
        // this doesn't make much sense, so we don't want this flow
        if (actionProposal === null)
            return null;

        acceptedAction = actionProposal;
    }

    if (actionProposal !== null && !C.isSameFunction(actionProposal.schema, acceptedAction.schema))
        return null;
    if (name !== null && !topResult.value.id.equals(name))
        return null;

    const chainParam = findChainParam(topResult, acceptedAction);
    if (!chainParam)
        return null;
    return addActionParam(ctx, 'execute', acceptedAction, chainParam, topResult.value.id, 'accepted');
}

function recommendationCancelReply(ctx, valid) {
    // see dialogue.genie for the meaning of this boolean
    if (!valid)
        return null;

    // "thank you" closes the dialogue
    // we cannot close the dialogue if we have pending actions
    if (ctx.next)
        return null;
    return makeSimpleState(ctx, 'cancel', null);
}

function recommendationLearnMoreReply(ctx, name) {
    const proposal = ctx.aux;
    const { topResult, } = proposal;
    if (name !== null && !topResult.value.id.equals(name))
        return null;
    return makeSimpleState(ctx, 'learn_more', null);
}

function repeatCommandReply(ctx) {
    if (ctx.next)
        return null;
    if (ctx.currentFunctionSchema.is_monitorable)
        return null;

    const clone = ctx.current.clone();
    clone.results = null;
    clone.confirm = 'accepted';
    return addNewItem(ctx, 'execute', null, 'accepted', clone);
}

module.exports = {
    makeActionRecommendation,
    makeRecommendation,
    makeThingpediaRecommendation,
    makeAnswerStyleRecommendation,
    checkRecommendation,
    checkActionForRecommendation,
    makeDisplayResult,
    combineDisplayResult,
    makeRecommendationReply,
    makeDisplayResultReply,

    positiveRecommendationReply,
    negativeRecommendationReply,
    recommendationCancelReply,
    recommendationLearnMoreReply,
    repeatCommandReply,
};

1	// -- mode: js; indent-tabs-mode: nil; js-basic-offset: 4 --
2	//
3	// This file is part of Genie
4	//
5	// Copyright 2020 The Board of Trustees of the Leland Stanford Junior University
6	//
7	// Licensed under the Apache License, Version 2.0 (the "License");
8	// you may not use this file except in compliance with the License.
9	// You may obtain a copy of the License at
10	//
11	// http://www.apache.org/licenses/LICENSE-2.0
12	//
13	// Unless required by applicable law or agreed to in writing, software
14	// distributed under the License is distributed on an "AS IS" BASIS,
15	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16	// See the License for the specific language governing permissions and
17	// limitations under the License.
18	//
19	// Author: Giovanni Campagna <gcampagn@cs.stanford.edu>
20	"use strict";
21
22	const assert = require('assert');	3✔
23
24	const ThingTalk = require('thingtalk');	3✔
25	const Ast = ThingTalk.Ast;	3✔
26
27	const C = require('../ast_manip');	3✔
28
29	const { SlotBag, checkAndAddSlot } = require('../slot_bag');	3✔
30	const {
31	makeAgentReply,
32	makeSimpleState,
33	addActionParam,
34	addNewItem,
35	} = require('../state_manip');	3✔
36	const {
37	isInfoPhraseCompatibleWithResult,
38	findChainParam
39	} = require('./common');	3✔
40	const {
41	refineFilterToAnswerQuestionOrChangeFilter,
42	combinePreambleAndRequest,
43	proposalReply
44	} = require('./refinement-helpers');	3✔
45	const {
46	checkInfoPhrase
47	} = require('./results');	3✔
48
49
50	function makeActionRecommendation(ctx, action) {
51	assert(action instanceof Ast.Invocation);	×
52
53	const results = ctx.results;	×
54	assert(results.length > 0);	×
55
56	const topResult = results[0];	×
57	const id = topResult.value.id;	×
58	if (!id)	×
59	return null;	×
60
61	if (action.in_params.length !== 1)	×
62	return null;	×
63
64	for (let param of action.in_params) {	×
65	if (param.value.equals(id))	×
66	return { topResult, info: null, action };	×
67	}
68
69	return null;	×
70	}
71
72	function makeRecommendation(ctx, name) {
73	const results = ctx.results;	82✔
74	assert(results.length > 0);	82✔
75
76	const topResult = results[0];	82✔
77	const id = topResult.value.id;	82✔
78
79	if (!id \|\| !id.equals(name))	82✔
80	return null;	72✔
81
82	return { topResult, ctx, info: null, action: ctx.nextInfo && ctx.nextInfo.isAction ? C.getInvocation(ctx.next) : null };	10!
83	}
84
85	function makeThingpediaRecommendation(ctx, info) {
86	const results = ctx.results;	5✔
87	assert(results.length > 0);	5✔
88
89	const topResult = results[0];	5✔
90	if (!topResult.value.id)	5!
91	return null;	×
92
93	if (!isInfoPhraseCompatibleWithResult(topResult, info))	5!
UNCOV 94	return null;	×
95
96	return { topResult, ctx, info, action: ctx.nextInfo && ctx.nextInfo.isAction ? C.getInvocation(ctx.next) : null };	5!
97	}
98
99
100	function checkRecommendation({ topResult, action: nextAction }, info) {
101	assert(info instanceof SlotBag);	6,266✔
102	if (!topResult.value.id)	6,266!
103	return null;	×
104
105	const resultType = topResult.value.id.getType();	6,266✔
106	const idType = info.schema.getArgType('id');	6,266✔
107	if (!idType \|\| !idType.equals(resultType))	6,266!
108	return null;	×
109
110	if (!isInfoPhraseCompatibleWithResult(topResult, info))	6,266✔
111	return null;	4,818✔
112
113	return { topResult, info, action: nextAction };	1,448✔
114	}
115
116	function checkActionForRecommendation({ topResult, info, action: nextAction }, action) {
117	if (!topResult.value.id)	×
118	return null;	×
119	const resultType = topResult.value.id.getType();	×
120
121	if (nextAction !== null) {	×
122	if (!C.isSameFunction(nextAction.schema, action.schema))	×
123	return null;	×
124	}
125
126	if (!C.hasArgumentOfType(action, resultType))	×
127	return null;	×
128
129	return { topResult, info, action };	×
130	}
131
132	// make a recommendation that looks like an answer, that is, "so and so is a ..."
133	function makeAnswerStyleRecommendation({ topResult, ctx, action }, filter) {
134	let info = new SlotBag(ctx.currentFunctionSchema);	1,368✔
135	info = checkAndAddSlot(info, filter);	1,368✔
136	if (info === null)	1,368!
137	return null;	×
138	info = checkInfoPhrase(ctx, info);	1,368✔
139	if (info === null)	1,368✔
140	return null;	1,360✔
141
142	return checkRecommendation({ topResult, action }, info);	8✔
143	}
144
145
146	function makeDisplayResult(ctx, info) {
147	const results = ctx.results;	4,628✔
148	assert(results.length > 0);	4,628✔
149	const topResult = results[0];	4,628✔
150
151	if (ctx.currentFunctionSchema.is_list)	4,628✔
152	return null;	328✔
153	if (!isInfoPhraseCompatibleWithResult(topResult, info))	4,300✔
154	return null;	4,077✔
155	info = checkInfoPhrase(ctx, info);	223✔
156	if (info === null)	223✔
157	return null;	61✔
158
159	return { topResult, ctx, info, action: ctx.nextInfo && ctx.nextInfo.isAction ? C.getInvocation(ctx.next) : null, hasAnythingElse: false };	162✔
160	}
161
162	function combineDisplayResult(proposal, newInfo) {
163	const { ctx, info:oldInfo } = proposal;	792✔
164	const results = ctx.results;	792✔
165	assert(results.length > 0);	792✔
166	const topResult = results[0];	792✔
167	assert (isInfoPhraseCompatibleWithResult(topResult, newInfo));	792✔
168
169	newInfo = SlotBag.merge(oldInfo, newInfo);	792✔
170	if (newInfo === null)	792✔
171	return null;	392✔
172
173	const newProposal = {};	400✔
174	Object.assign(newProposal, proposal);	400✔
175	newProposal.info = newInfo;	400✔
176	return newProposal;	400✔
177	}
178
179	function makeRecommendationReply(ctx, proposal) {
180	const { topResult, action, hasLearnMore } = proposal;	1,524✔
181	const options = {};	1,524✔
182	if (action \|\| hasLearnMore)	1,524✔
183	options.end = false;	960✔
184	if (action === null) {	1,524!
185	return makeAgentReply(ctx, makeSimpleState(ctx, 'sys_recommend_one', null), proposal, null, options);	1,524✔
186	} else {
187	const chainParam = findChainParam(topResult, action);	×
188	if (!chainParam)	×
189	return null;	×
190	return makeAgentReply(ctx, addActionParam(ctx, 'sys_recommend_one', action, chainParam, topResult.value.id, 'proposed'),	×
191	proposal, null, options);
192	}
193	}
194
195	function makeDisplayResultReply(ctx, proposal) {
196	const { action, hasAnythingElse } = proposal;	627✔
197	const options = {};	627✔
198	if (action \|\| hasAnythingElse)	627✔
199	options.end = false;	144✔
200	return makeAgentReply(ctx, makeSimpleState(ctx, 'sys_display_result', null), proposal, null, options);	627✔
201	}
202
203	function negativeRecommendationReply(ctx, [preamble, request]) {
204	const proposal = ctx.aux;	293,415✔
205	const { topResult, info, } = proposal;	293,415✔
206	const proposalType = topResult.value.id.getType();	293,415✔
207	request = combinePreambleAndRequest(preamble, request, info, proposalType);	293,415✔
208	if (request === null)	293,415✔
209	return null;	286,045✔
210	return proposalReply(ctx, request, refineFilterToAnswerQuestionOrChangeFilter);	7,370✔
211	}
212
213	function positiveRecommendationReply(ctx, acceptedAction, name) {
214	const proposal = ctx.aux;	143✔
215	const { topResult, action: actionProposal } = proposal;	143✔
216
217	if (acceptedAction === null) {	143✔
218	// if the user did not give an action earlier, and no action
219	// was proposed by the agent right now, the flow is roughly
220	//
221	// U: hello i am looking for a restaurant
222	// A: how about the ... ?
223	// U: sure I like that
224	//
225	// this doesn't make much sense, so we don't want this flow
226	if (actionProposal === null)	108!
227	return null;	108✔
228
229	acceptedAction = actionProposal;	×
230	}
231
232	if (actionProposal !== null && !C.isSameFunction(actionProposal.schema, acceptedAction.schema))	35!
233	return null;	×
234	if (name !== null && !topResult.value.id.equals(name))	35!
235	return null;	×
236
237	const chainParam = findChainParam(topResult, acceptedAction);	35✔
238	if (!chainParam)	35✔
239	return null;	21✔
240	return addActionParam(ctx, 'execute', acceptedAction, chainParam, topResult.value.id, 'accepted');	14✔
241	}
242
243	function recommendationCancelReply(ctx, valid) {
244	// see dialogue.genie for the meaning of this boolean
245	if (!valid)	324✔
246	return null;	108✔
247
248	// "thank you" closes the dialogue
249	// we cannot close the dialogue if we have pending actions
250	if (ctx.next)	216!
251	return null;	×
252	return makeSimpleState(ctx, 'cancel', null);	216✔
253	}
254
255	function recommendationLearnMoreReply(ctx, name) {
256	const proposal = ctx.aux;	216✔
257	const { topResult, } = proposal;	216✔
258	if (name !== null && !topResult.value.id.equals(name))	216!
259	return null;	×
260	return makeSimpleState(ctx, 'learn_more', null);	216✔
261	}
262
263	function repeatCommandReply(ctx) {
264	if (ctx.next)	×
265	return null;	×
266	if (ctx.currentFunctionSchema.is_monitorable)	×
267	return null;	×
268
269	const clone = ctx.current.clone();	×
270	clone.results = null;	×
271	clone.confirm = 'accepted';	×
272	return addNewItem(ctx, 'execute', null, 'accepted', clone);	×
273	}
274
275	module.exports = {	3✔
276	makeActionRecommendation,
277	makeRecommendation,
278	makeThingpediaRecommendation,
279	makeAnswerStyleRecommendation,
280	checkRecommendation,
281	checkActionForRecommendation,
282	makeDisplayResult,
283	combineDisplayResult,
284	makeRecommendationReply,
285	makeDisplayResultReply,
286
287	positiveRecommendationReply,
288	negativeRecommendationReply,
289	recommendationCancelReply,
290	recommendationLearnMoreReply,
291	repeatCommandReply,
292	};

stanford-oval / genie-toolkit / 1190

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous