.. _package-rst-dialog: ==================== Package rst.dialog ==================== Types in this package describe verbal communication between agents in an interaction context. Messages ======== .. container:: mess4ge-multi .. container:: mess4ge-graph .. digraph:: message_graph fontname="Arial"; fontsize=11; stylesheet="../_static/graphs.css"; node [fontsize=11,fontname="Arial"] edge [fontsize=11,fontname="Arial"] "13" [label=<
DialogManagerCommand
Commandcommand
ASCII-STRINGpattern_name
>,shape=box,style=filled,fillcolor="white"]; "14" [label=<
Command
RESET_INTERACTION0
RESET_PATTERN1
>,shape=box,style=filled,fillcolor="white"]; "6" [label=<
DialogActCollection
DialogActelement
>,shape=box,style=filled,fillcolor="white"]; "7" [label=<
DialogAct
Typetype
IncrementalUnitincremental_unit
SpeechHypothesesspeech_hypotheses
>,shape=box,style=filled,fillcolor="white"]; "9" [label=<
SpeechHypotheses
SpeechHypothesisbest_result
SpeechHypothesisfurther_results
BOOLfinal
>,shape=box,style=filled,fillcolor="white"]; "10" [label=<
SpeechHypothesis
Wordwords
FLOAT32confidence
Intervaltimestamp
ASCII-STRINGgrammar_tree
>,shape=box,style=filled,fillcolor="white"]; "11" [label=<
Word
ASCII-STRINGword
Intervaltimestamps
PartOfSpeechTagpart_of_speech_tag
>,shape=box,style=filled,fillcolor="white"]; "12" [label=<
PartOfSpeechTag
ADJA1
ADJD2
ADV3
APPR4
APPRART5
APPO6
APZR7
ART8
CARD9
FM10
ITJ11
ORD12
KOUI13
KOUS14
KON15
KOKOM16
NN17
NE18
PDS19
PDAT20
PIS21
PIAT22
PIDAT23
PPER24
PPOSS25
PPOSAT26
PRELS27
PRELAT28
PRF29
PWS30
PWAT31
PWAV32
PAV33
PTKZU34
PTKNEG35
PTKVZ36
PTKANT37
PTKA38
SGML39
SPELL40
TRUNC41
VVFIN42
VVIMP43
VVINF44
VVIZU45
VVPP46
VAFIN47
VAIMP48
VAINF49
VAPP50
VMFIN51
VMINF52
VMPP53
XY54
KOMM55
END56
IPNCT57
>,shape=box,style=filled,fillcolor="white"]; "8" [label=<
Type
GREET0
ACCEPT1
REJECT2
CONFIRM3
NEGATE4
INFO_REQUEST5
ACTION_REQUEST6
STATEMENT7
ANSWER8
GOODBYE9
OTHER100
>,shape=box,style=filled,fillcolor="white"]; "1" [label=<
IncrementalUnitCollection
IncrementalUnitelement
>,shape=box,style=filled,fillcolor="white"]; "2" [label=<
IncrementalUnit
Intervaltimestamps
OCTET-VECTORid
OCTET-VECTORsll_id
OCTET-VECTORgil_id
EditTypestate
>,shape=box,style=filled,fillcolor="white"]; "5" [label=<
EditType
ADD0
UPDATED1
REVOKE2
COMMIT3
>,shape=box,style=filled,fillcolor="white"]; "3" [label=<
Interval
Timestampbegin
Timestampend
>,shape=box,style=filled,fillcolor="white"]; "4" [label=<
Timestamp
UINT64time
>,shape=box,style=filled,fillcolor="white"]; "13" -> "14"[dir=both,arrowtail=odiamond]; "13":command -> "14"[]; "6":element -> "7"[]; "7" -> "8"[dir=both,arrowtail=odiamond]; "7":speech_hypotheses -> "9"[]; "7":incremental_unit -> "2"[]; "7":type -> "8"[]; "9":further_results -> "10"[]; "9":best_result -> "10"[]; "10" -> "11"[dir=both,arrowtail=odiamond]; "10":timestamp -> "3"[]; "10":words -> "11"[]; "11" -> "12"[dir=both,arrowtail=odiamond]; "11":part_of_speech_tag -> "12"[]; "11":timestamps -> "3"[]; "1":element -> "2"[]; "2" -> "5"[dir=both,arrowtail=odiamond]; "2":state -> "5"[]; "2":timestamps -> "3"[]; "3":end -> "4"[]; "3":begin -> "4"[]; .. container:: mess4ge-list .. container:: messages * :ref:`IncrementalUnitCollection ` * :ref:`DialogActCollection ` * :ref:`DialogManagerCommand ` * :ref:`DialogAct ` * :ref:`SpeechHypotheses ` * :ref:`SpeechHypothesis ` * :ref:`IncrementalUnit ` .. container:: clearer clearer: should be made invisible via css .. _message-rst-dialog-incrementalunitcollection: Message IncrementalUnitCollection --------------------------------- .. container:: message-rst-dialog-incrementalunitcollection-multi .. container:: message-rst-dialog-incrementalunitcollection-documentation .. py:class:: rst.dialog.IncrementalUnitCollection Collection of :py:class:`IncrementalUnit ` instances. Auto-generated. .. py:attribute:: element :type: array of :py:class:`rst.dialog.IncrementalUnit` The individual elements of the collection. Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific. .. container:: message-rst-dialog-incrementalunitcollection-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/IncrementalUnitCollection.proto :lines: 14-24 :language: protobuf :emphasize-lines: 9-9 .. _message-rst-dialog-dialogactcollection: Message DialogActCollection --------------------------- .. container:: message-rst-dialog-dialogactcollection-multi .. container:: message-rst-dialog-dialogactcollection-documentation .. py:class:: rst.dialog.DialogActCollection Collection of :py:class:`DialogAct ` instances. Auto-generated. .. py:attribute:: element :type: array of :py:class:`rst.dialog.DialogAct` The individual elements of the collection. Constraints regarding the empty collection, sorting, duplicated entries etc. are use case specific. .. container:: message-rst-dialog-dialogactcollection-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/DialogActCollection.proto :lines: 14-24 :language: protobuf :emphasize-lines: 9-9 .. _message-rst-dialog-dialogmanagercommand: Message DialogManagerCommand ---------------------------- .. container:: message-rst-dialog-dialogmanagercommand-multi .. container:: message-rst-dialog-dialogmanagercommand-documentation .. py:class:: rst.dialog.DialogManagerCommand A description of a command for a dialog manager. .. codeauthor:: Birte Carlmeyer .. py:attribute:: command :type: :py:class:`rst.dialog.DialogManagerCommand.Command` The chosen command for the dialog manager .. py:attribute:: pattern_name :type: :py:class:`ASCII-STRING` An interaction pattern referenced for the current command. .. container:: message-rst-dialog-dialogmanagercommand-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/DialogManagerCommand.proto :lines: 12-43 :language: protobuf :emphasize-lines: 25-25,30-30 .. _message-rst-dialog-dialogmanagercommand-command: Message Command --------------- .. container:: message-rst-dialog-dialogmanagercommand-command-multi .. container:: message-rst-dialog-dialogmanagercommand-command-documentation .. py:class:: rst.dialog.DialogManagerCommand.Command Possible kinds of commands. .. py:attribute:: RESET_INTERACTION = 0 Reset the whole interaction. .. py:attribute:: RESET_PATTERN = 1 Reset a single interaction pattern. Requires the :py:attr:`pattern_name ` name to be set. .. container:: message-rst-dialog-dialogmanagercommand-command-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/DialogManagerCommand.proto :lines: 17-31 :language: protobuf :emphasize-lines: 6-6,13-13 .. _message-rst-dialog-dialogact: Message DialogAct ----------------- .. container:: message-rst-dialog-dialogact-multi .. container:: message-rst-dialog-dialogact-documentation .. py: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. .. codeauthor:: Birte Carlmeyer @create_collection .. py:attribute:: type :type: :py:class:`rst.dialog.DialogAct.Type` The type of the current dialog act. .. py:attribute:: incremental_unit :type: :py:class:`rst.dialog.IncrementalUnit` The basic information of the dialog act IU. .. py:attribute:: speech_hypotheses :type: :py:class:`rst.dialog.SpeechHypotheses` The underlying speech recognition result causing this dialog act. .. container:: message-rst-dialog-dialogact-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/DialogAct.proto :lines: 18-99 :language: protobuf :emphasize-lines: 70-70,75-75,80-80 .. _message-rst-dialog-dialogact-type: Message Type ------------ .. container:: message-rst-dialog-dialogact-type-multi .. container:: message-rst-dialog-dialogact-type-documentation .. py:class:: rst.dialog.DialogAct.Type Possible kinds of dialog acts. .. py:attribute:: GREET = 0 Conversation opening. .. py:attribute:: ACCEPT = 1 Affirmative answer. .. py:attribute:: REJECT = 2 Negative answer. .. py:attribute:: CONFIRM = 3 Confirmation .. py:attribute:: NEGATE = 4 Negation .. py:attribute:: INFO_REQUEST = 5 Speaker wants an information from addressee. .. py:attribute:: ACTION_REQUEST = 6 Speaker offers to perform an action. .. py:attribute:: STATEMENT = 7 A statement. .. py:attribute:: ANSWER = 8 An answer (not a yes/no answer). .. py:attribute:: GOODBYE = 9 Conversation closing. .. py:attribute:: OTHER = 100 The current dialog act doesn't match to any of the previous types. .. container:: message-rst-dialog-dialogact-type-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/DialogAct.proto :lines: 23-81 :language: protobuf :emphasize-lines: 6-6,11-11,16-16,21-21,26-26,31-31,36-36,41-41,46-46,51-51,57-57 .. _message-rst-dialog-speechhypotheses: Message SpeechHypotheses ------------------------ .. container:: message-rst-dialog-speechhypotheses-multi .. container:: message-rst-dialog-speechhypotheses-documentation .. py:class:: rst.dialog.SpeechHypotheses A set of potential speech hypotheses for a single utterance representing different interpretations. .. codeauthor:: Birte Carlmeyer .. codeauthor:: Soeren Klett .. py:attribute:: best_result :type: :py:class:`rst.dialog.SpeechHypothesis` The best speech recognition result. .. py:attribute:: further_results :type: array of :py:class:`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 :py:attr:`best_result ` is not included in this list. .. py:attribute:: final :type: :py:class:`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. .. container:: message-rst-dialog-speechhypotheses-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/SpeechHypotheses.proto :lines: 16-39 :language: protobuf :emphasize-lines: 6-6,14-14,22-22 .. _message-rst-dialog-speechhypothesis: Message SpeechHypothesis ------------------------ .. container:: message-rst-dialog-speechhypothesis-multi .. container:: message-rst-dialog-speechhypothesis-documentation .. py:class:: rst.dialog.SpeechHypothesis A hypothesis about a speech recognition result. .. codeauthor:: Birte Carlmeyer .. codeauthor:: Soeren Klett .. py:attribute:: words :type: array of :py:class:`rst.dialog.SpeechHypothesis.Word` List of word speech recognition results. .. py:attribute:: confidence :type: :py:class:`FLOAT32` **Constraint**: ``0 <= value <= 1`` Confidence for this speech hypothesis. .. py:attribute:: timestamp :type: :py:class:`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. .. py:attribute:: grammar_tree :type: :py:class:`ASCII-STRING` The grammar tree of this speech hypothesis. .. container:: message-rst-dialog-speechhypothesis-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/SpeechHypothesis.proto :lines: 15-368 :language: protobuf :emphasize-lines: 334-334,340-340,347-347,352-352 .. _message-rst-dialog-speechhypothesis-word: Message Word ------------ .. container:: message-rst-dialog-speechhypothesis-word-multi .. container:: message-rst-dialog-speechhypothesis-word-documentation .. py:class:: rst.dialog.SpeechHypothesis.Word Speech recognition result for a single word. .. py:attribute:: word :type: :py:class:`ASCII-STRING` Speech recognition result for a single word. .. py:attribute:: timestamps :type: :py:class:`rst.timing.Interval` Start and end time for this word. If specified, this must be within the bounds of :py:attr:`timestamp ` .. py:attribute:: part_of_speech_tag :type: :py:class:`rst.dialog.SpeechHypothesis.Word.PartOfSpeechTag` Stuttgart-Tübingen-Tagset (STTS) Part-of-speech tag for this word (assumes German). .. container:: message-rst-dialog-speechhypothesis-word-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/SpeechHypothesis.proto :lines: 20-343 :language: protobuf :emphasize-lines: 6-6,14-14,322-322 .. _message-rst-dialog-speechhypothesis-word-partofspeechtag: Message PartOfSpeechTag ----------------------- .. container:: message-rst-dialog-speechhypothesis-word-partofspeechtag-multi .. container:: message-rst-dialog-speechhypothesis-word-partofspeechtag-documentation .. py:class:: rst.dialog.SpeechHypothesis.Word.PartOfSpeechTag Part-of-speech tags for German using a modified version of the Stuttgart-Tübingen-Tagset (STTS). Differences w.r.t. STTS are: * ``KOMM`` instead of ``$,`` * ``END`` instead of ``$.`` * ``IPNCT`` instead of ``$(`` .. seealso:: Description of the STTS (in German) http://www.coli.uni-saarland.de/projects/sfb378/negra-corpus/stts.asc .. py:attribute:: ADJA = 1 Attributives Adjektiv. .. py:attribute:: ADJD = 2 Adverbiales oder prädikatives Adjektiv. .. py:attribute:: ADV = 3 Adverb .. py:attribute:: APPR = 4 Präposition; Zirkumposition links. .. py:attribute:: APPRART = 5 Präposition mit Artikel. .. py:attribute:: APPO = 6 Postposition .. py:attribute:: APZR = 7 Zirkumposition rechts. .. py:attribute:: ART = 8 Bestimmter oder unbestimmter Artikel. .. py:attribute:: CARD = 9 Kardinalzahl .. py:attribute:: FM = 10 Fremdsprachliches Material. .. py:attribute:: ITJ = 11 Interjektion .. py:attribute:: ORD = 12 Ordinalzahl .. py:attribute:: KOUI = 13 Unterordnende Konjunktion. .. py:attribute:: KOUS = 14 Unterordnende Konjunktion. .. py:attribute:: KON = 15 Nebenordnende Konjunktion. .. py:attribute:: KOKOM = 16 Vergleichskonjunktion .. py:attribute:: NN = 17 Normales Nomen. .. py:attribute:: NE = 18 Eigennamen .. py:attribute:: PDS = 19 Substituierendes Demonstrativpronomen. .. py:attribute:: PDAT = 20 Attribuierendes Demonstrativpronomen. .. py:attribute:: PIS = 21 Substituierendes Indefinitpronomen. .. py:attribute:: PIAT = 22 Attribuierendes Indefinitpronomen ohne Determiner. .. py:attribute:: PIDAT = 23 Attribuierendes Indefinitpronomen mit Determiner. .. py:attribute:: PPER = 24 Irreflexives Personalpronomen. .. py:attribute:: PPOSS = 25 Substituierendes Possessivpronomen. .. py:attribute:: PPOSAT = 26 Attribuierendes Possessivpronomen. .. py:attribute:: PRELS = 27 Substituierendes Relativpronomen. .. py:attribute:: PRELAT = 28 Attribuierendes Relativpronomen. .. py:attribute:: PRF = 29 Reflexives Personalpronomen. .. py:attribute:: PWS = 30 Substituierendes Interrogativpronomen. .. py:attribute:: PWAT = 31 Attribuierendes Interrogativpronomen. .. py:attribute:: PWAV = 32 Adverbiales Interrogativ- oder Relativpronomen. .. py:attribute:: PAV = 33 Pronominaladverb .. py:attribute:: PTKZU = 34 "zu" vor Infinitiv. .. py:attribute:: PTKNEG = 35 Negationspartikel .. py:attribute:: PTKVZ = 36 Abgetrennter Verbzusatz. .. py:attribute:: PTKANT = 37 Antwortpartikel .. py:attribute:: PTKA = 38 Partikel bei Adjektiv oder Adverb. .. py:attribute:: SGML = 39 SGML Markup. .. py:attribute:: SPELL = 40 Buchstabierfolge .. py:attribute:: TRUNC = 41 Kompositions-Erstglied .. py:attribute:: VVFIN = 42 Finites Verb, voll. .. py:attribute:: VVIMP = 43 Imperativ, voll. .. py:attribute:: VVINF = 44 Infinitiv, voll. .. py:attribute:: VVIZU = 45 Infinitiv mit "zu", voll. .. py:attribute:: VVPP = 46 Partizip Perfekt, voll. .. py:attribute:: VAFIN = 47 Finites Verb, aux. .. py:attribute:: VAIMP = 48 Imperativ, aux. .. py:attribute:: VAINF = 49 Infinitiv, aux. .. py:attribute:: VAPP = 50 Partizip Perfekt, aux. .. py:attribute:: VMFIN = 51 Finites Verb, modal. .. py:attribute:: VMINF = 52 Infinitiv, modal. .. py:attribute:: VMPP = 53 Partizip Perfekt, modal. .. py:attribute:: XY = 54 Nichtwort, Sonderzeichen enthaltend. .. py:attribute:: KOMM = 55 Komma .. py:attribute:: END = 56 Satzbeendende Interpunktion. .. py:attribute:: IPNCT = 57 Sonstige Satzzeichen; satzintern. .. container:: message-rst-dialog-speechhypothesis-word-partofspeechtag-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/SpeechHypothesis.proto :lines: 48-335 :language: protobuf :emphasize-lines: 6-6,11-11,16-16,21-21,26-26,31-31,36-36,41-41,46-46,51-51,56-56,61-61,66-66,71-71,76-76,81-81,86-86,91-91,96-96,101-101,106-106,111-111,116-116,121-121,126-126,131-131,136-136,141-141,146-146,151-151,156-156,161-161,166-166,171-171,176-176,181-181,186-186,191-191,196-196,201-201,206-206,211-211,216-216,221-221,226-226,231-231,236-236,241-241,246-246,251-251,256-256,261-261,266-266,271-271,276-276,281-281,286-286 .. _message-rst-dialog-incrementalunit: Message IncrementalUnit ----------------------- .. container:: message-rst-dialog-incrementalunit-multi .. container:: message-rst-dialog-incrementalunit-documentation .. py:class:: rst.dialog.IncrementalUnit A description of the basic information of an incremental unit (IU) of the IU-model of incremental dialogue processing. .. seealso:: A General, Abstract Model of Incremental Dialogue Processing http://wwwhomes.uni-bielefeld.de/dschlangen/inpro/abstractModel.html .. codeauthor:: Birte Carlmeyer @create_collection .. py:attribute:: timestamps :type: :py:class:`rst.timing.Interval` Start and end time of the incremental unit. .. py:attribute:: id :type: :py:class:`OCTET-VECTOR` A unique id for the incremental unit. .. py:attribute:: sll_id :type: array of :py:class:`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. .. py:attribute:: gil_id :type: array of :py:class:`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. .. py:attribute:: state :type: :py:class:`rst.dialog.IncrementalUnit.EditType` Edit type of the incremental unit. .. container:: message-rst-dialog-incrementalunit-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/IncrementalUnit.proto :lines: 19-80 :language: protobuf :emphasize-lines: 34-34,39-39,46-46,55-55,60-60 .. _message-rst-dialog-incrementalunit-edittype: Message EditType ---------------- .. container:: message-rst-dialog-incrementalunit-edittype-multi .. container:: message-rst-dialog-incrementalunit-edittype-documentation .. py:class:: rst.dialog.IncrementalUnit.EditType The incremental unit can be in different states. .. py:attribute:: ADD = 0 Indicates a new incremental unit. .. py:attribute:: UPDATED = 1 Replaces the last incremental unit. .. py:attribute:: REVOKE = 2 Revokes a previously added unit. .. py:attribute:: COMMIT = 3 The incremental unit has been finally committed and will not be changed any more. .. container:: message-rst-dialog-incrementalunit-edittype-source :download:`Download this file ` .. literalinclude:: //home/jenkins/workspace/rst-manual-0.17/upstream/RST-0.17.1-Linux/share/rst0.17/proto/stable/rst/dialog/IncrementalUnit.proto :lines: 24-47 :language: protobuf :emphasize-lines: 6-6,11-11,16-16,22-22