Package rst.dialog¶
Types in this package describe verbal communication between agents in an interaction context.
Messages¶
Message IncrementalUnitCollection¶
-
class
rst.dialog.
IncrementalUnitCollection
¶ Collection of
IncrementalUnit
instances.Auto-generated.
-
element
¶ Type: array of rst.dialog.IncrementalUnit
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific.
-
message IncrementalUnitCollection {
/**
* The individual elements of the collection.
*
* Constraints regarding the empty collection, sorting, duplicated
* entries etc. are use case specific.
*/
repeated IncrementalUnit element = 1;
}
Message DialogActCollection¶
-
class
rst.dialog.
DialogActCollection
¶ Collection of
DialogAct
instances.Auto-generated.
-
element
¶ Type: array of rst.dialog.DialogAct
The individual elements of the collection.
Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific.
-
message DialogActCollection {
/**
* The individual elements of the collection.
*
* Constraints regarding the empty collection, sorting, duplicated
* entries etc. are use case specific.
*/
repeated DialogAct element = 1;
}
Message DialogManagerCommand¶
-
class
rst.dialog.
DialogManagerCommand
¶ A description of a command for a dialog manager.
Code author: Birte Carlmeyer <bcarlmey@techfak.uni-bielefeld.de>
-
command
¶ Type: rst.dialog.DialogManagerCommand.Command
The chosen command for the dialog manager
-
pattern_name
¶ Type: ASCII-STRING
An interaction pattern referenced for the current command.
-
message DialogManagerCommand {
/**
* Possible kinds of commands.
*/
enum Command {
/**
* Reset the whole interaction.
*/
RESET_INTERACTION = 0;
/*
* Reset a single interaction pattern. Requires the
* @ref .rst.dialog.DialogManagerCommand.pattern_name name to be
* set.
*/
RESET_PATTERN = 1;
}
/**
* The chosen command for the dialog manager
*/
required Command command = 1;
/**
* An interaction pattern referenced for the current command.
*/
optional string pattern_name = 2;
}
Message Command¶
-
class
rst.dialog.DialogManagerCommand.
Command
¶ Possible kinds of commands.
-
RESET_INTERACTION
¶ -
= 0
Reset the whole interaction.
-
RESET_PATTERN
¶ -
= 1
Reset a single interaction pattern. Requires the
pattern_name
name to be set.
-
enum Command {
/**
* Reset the whole interaction.
*/
RESET_INTERACTION = 0;
/*
* Reset a single interaction pattern. Requires the
* @ref .rst.dialog.DialogManagerCommand.pattern_name name to be
* set.
*/
RESET_PATTERN = 1;
}
Message DialogAct¶
-
class
rst.dialog.
DialogAct
¶ A description of a dialog act as a specialization of an incremental unit containing an XML representation of a speech hypothesis as payload.
Code author: Birte Carlmeyer <bcarlmey@techfak.uni-bielefeld.de>
@create_collection
-
type
¶ Type: rst.dialog.DialogAct.Type
The type of the current dialog act.
-
incremental_unit
¶ Type: rst.dialog.IncrementalUnit
The basic information of the dialog act IU.
-
speech_hypotheses
¶ Type: rst.dialog.SpeechHypotheses
The underlying speech recognition result causing this dialog act.
-
message DialogAct {
/**
* Possible kinds of dialog acts.
*/
enum Type {
/**
* Conversation opening.
*/
GREET = 0;
/**
* Affirmative answer.
*/
ACCEPT = 1;
/**
* Negative answer.
*/
REJECT = 2;
/**
* Confirmation.
*/
CONFIRM = 3;
/**
* Negation.
*/
NEGATE = 4;
/**
* Speaker wants an information from addressee.
*/
INFO_REQUEST = 5;
/**
* Speaker offers to perform an action.
*/
ACTION_REQUEST = 6;
/**
* A statement.
*/
STATEMENT = 7;
/**
* An answer (not a yes/no answer).
*/
ANSWER = 8;
/**
* Conversation closing.
*/
GOODBYE = 9;
/**
* The current dialog act doesn't match to any of the previous
* types.
*/
OTHER = 100;
}
/**
* The type of the current dialog act.
*/
required Type type = 1;
/**
* The basic information of the dialog act IU.
*/
required IncrementalUnit incremental_unit = 2;
/**
* The underlying speech recognition result causing this dialog act.
*/
optional SpeechHypotheses speech_hypotheses = 3;
}
Message Type¶
-
class
rst.dialog.DialogAct.
Type
¶ Possible kinds of dialog acts.
-
GREET
¶ -
= 0
Conversation opening.
-
ACCEPT
¶ -
= 1
Affirmative answer.
-
REJECT
¶ -
= 2
Negative answer.
-
CONFIRM
¶ -
= 3
Confirmation
-
NEGATE
¶ -
= 4
Negation
-
INFO_REQUEST
¶ -
= 5
Speaker wants an information from addressee.
-
ACTION_REQUEST
¶ -
= 6
Speaker offers to perform an action.
-
STATEMENT
¶ -
= 7
A statement.
-
ANSWER
¶ -
= 8
An answer (not a yes/no answer).
-
GOODBYE
¶ -
= 9
Conversation closing.
-
OTHER
¶ -
= 100
The current dialog act doesn’t match to any of the previous types.
-
enum Type {
/**
* Conversation opening.
*/
GREET = 0;
/**
* Affirmative answer.
*/
ACCEPT = 1;
/**
* Negative answer.
*/
REJECT = 2;
/**
* Confirmation.
*/
CONFIRM = 3;
/**
* Negation.
*/
NEGATE = 4;
/**
* Speaker wants an information from addressee.
*/
INFO_REQUEST = 5;
/**
* Speaker offers to perform an action.
*/
ACTION_REQUEST = 6;
/**
* A statement.
*/
STATEMENT = 7;
/**
* An answer (not a yes/no answer).
*/
ANSWER = 8;
/**
* Conversation closing.
*/
GOODBYE = 9;
/**
* The current dialog act doesn't match to any of the previous
* types.
*/
OTHER = 100;
}
Message SpeechHypotheses¶
-
class
rst.dialog.
SpeechHypotheses
¶ A set of potential speech hypotheses for a single utterance representing different interpretations.
Code author: Birte Carlmeyer <bcarlmey@techfak.uni-bielefeld.de>
Code author: Soeren Klett <sklett@techfak.uni-bielefeld.de>
-
best_result
¶ Type: rst.dialog.SpeechHypothesis
The best speech recognition result.
-
further_results
¶ Type: array of rst.dialog.SpeechHypothesis
A list of potential other interpretations of the speech signal ordered by confidence. The first entry represents the hypothesis with the highest confidence. The
best_result
is not included in this list.
-
final
¶ Type: BOOL
Indicates whether the current result might be superseded with further results due to incremental processing or not. A value of true indicates that no further hypotheses for the represented speech utterance will be produced in the future.
-
message SpeechHypotheses {
/**
* The best speech recognition result.
*/
required SpeechHypothesis best_result = 1;
/**
* A list of potential other interpretations of the speech signal
* ordered by confidence. The first entry represents the hypothesis
* with the highest confidence. The @ref .best_result is not
* included in this list.
*/
repeated SpeechHypothesis further_results = 2;
/**
* Indicates whether the current result might be superseded with
* further results due to incremental processing or not. A value of
* true indicates that no further hypotheses for the represented
* speech utterance will be produced in the future.
*/
required bool final = 3;
}
Message SpeechHypothesis¶
-
class
rst.dialog.
SpeechHypothesis
¶ A hypothesis about a speech recognition result.
Code author: Birte Carlmeyer <bcarlmey@techfak.uni-bielefeld.de>
Code author: Soeren Klett <sklett@techfak.uni-bielefeld.de>
-
words
¶ Type: array of rst.dialog.SpeechHypothesis.Word
List of word speech recognition results.
-
confidence
¶ Type: FLOAT32
Constraint:
0 <= value <= 1
Confidence for this speech hypothesis.
-
timestamp
¶ Type: rst.timing.Interval
Start and end time for this speech hypothesis. Since some speech recognizers may not provide detailed results for each word, this field may be used to indicate the time of the overall hypothesis.
-
grammar_tree
¶ Type: ASCII-STRING
The grammar tree of this speech hypothesis.
-
message SpeechHypothesis {
/**
* Speech recognition result for a single word.
*/
message Word {
/**
* Speech recognition result for a single word.
*/
required string word = 1;
/**
* Start and end time for this word.
*
* If specified, this must be within the bounds of
* @ref .rst.dialog.SpeechHypothesis.timestamp
*/
optional timing.Interval timestamps = 2;
}
/**
* List of word speech recognition results.
*/
repeated Word words = 1;
/**
* Confidence for this speech hypothesis.
*/
// @constraint(0 <= value <= 1)
optional float confidence = 2;
/**
* Start and end time for this speech hypothesis. Since some speech
* recognizers may not provide detailed results for each word, this
* field may be used to indicate the time of the overall hypothesis.
*/
optional timing.Interval timestamp = 3;
/**
* The grammar tree of this speech hypothesis.
*/
optional string grammar_tree = 4;
}
Message Word¶
-
class
rst.dialog.SpeechHypothesis.
Word
¶ Speech recognition result for a single word.
-
word
¶ Type: ASCII-STRING
Speech recognition result for a single word.
-
timestamps
¶ Type: rst.timing.Interval
Start and end time for this word.
If specified, this must be within the bounds of
timestamp
-
message Word {
/**
* Speech recognition result for a single word.
*/
required string word = 1;
/**
* Start and end time for this word.
*
* If specified, this must be within the bounds of
* @ref .rst.dialog.SpeechHypothesis.timestamp
*/
optional timing.Interval timestamps = 2;
}
Message IncrementalUnit¶
-
class
rst.dialog.
IncrementalUnit
¶ A description of the basic information of an incremental unit (IU) of the IU-model of incremental dialogue processing.
See also
- A General, Abstract Model of Incremental Dialogue Processing
- http://wwwhomes.uni-bielefeld.de/dschlangen/inpro/abstractModel.html
Code author: Birte Carlmeyer <bcarlmey@techfak.uni-bielefeld.de>
@create_collection
-
timestamps
¶ Type: rst.timing.Interval
Start and end time of the incremental unit.
-
id
¶ Type: OCTET-VECTOR
A unique id for the incremental unit.
-
sll_id
¶ Type: array of OCTET-VECTOR
Optional id list of IU which have a same-level link. Same-level links (sll) connect IUs, which are produced by the same module and reflect their temporal order.
-
gil_id
¶ Type: array of OCTET-VECTOR
Optional id list of IU which have a grounded-in link. Grounded-in links (gil) represent on which IUs they depend, thus representing the possibility to build a hierarchical structure. Entries are sorted by time and nesting level of the created graph.
-
state
¶ Type: rst.dialog.IncrementalUnit.EditType
Edit type of the incremental unit.
message IncrementalUnit {
/**
* The incremental unit can be in different states.
*/
enum EditType {
/**
* Indicates a new incremental unit.
*/
ADD = 0;
/**
* Replaces the last incremental unit.
*/
UPDATED = 1;
/**
* Revokes a previously added unit.
*/
REVOKE = 2;
/**
* The incremental unit has been finally committed and will not
* be changed any more.
*/
COMMIT = 3;
}
/**
* Start and end time of the incremental unit.
*/
optional timing.Interval timestamps = 2;
/**
* A unique id for the incremental unit.
*/
required bytes id = 3;
/**
* Optional id list of IU which have a same-level link.
* Same-level links (sll) connect IUs, which are produced by the
* same module and reflect their temporal order.
*/
repeated bytes sll_id = 4;
/**
* Optional id list of IU which have a grounded-in link.
* Grounded-in links (gil) represent on which IUs they depend, thus
* representing the possibility to build a hierarchical structure.
* Entries are sorted by time and nesting level of the created
* graph.
*/
repeated bytes gil_id = 5;
/**
* Edit type of the incremental unit.
*/
required EditType state = 6;
}
Message EditType¶
-
class
rst.dialog.IncrementalUnit.
EditType
¶ The incremental unit can be in different states.
-
ADD
¶ -
= 0
Indicates a new incremental unit.
-
UPDATED
¶ -
= 1
Replaces the last incremental unit.
-
REVOKE
¶ -
= 2
Revokes a previously added unit.
-
COMMIT
¶ -
= 3
The incremental unit has been finally committed and will not be changed any more.
-
enum EditType {
/**
* Indicates a new incremental unit.
*/
ADD = 0;
/**
* Replaces the last incremental unit.
*/
UPDATED = 1;
/**
* Revokes a previously added unit.
*/
REVOKE = 2;
/**
* The incremental unit has been finally committed and will not
* be changed any more.
*/
COMMIT = 3;
}