Skip to content

inform

Adds one predicate proposition to shared commitments and requests that the system inform the user.

<inform insist="false" generate_end_turn="true" expected_passivity="2.0">
  <proposition predicate="first_name" value="Charlie"/>
</inform>

Attributes and placement

Attribute Default Meaning
insist false If false, suppresses the inform when a proposition for the same predicate is already shared. If true, informs despite an existing value.
generate_end_turn false Adds an end-turn after the inform when true.
expected_passivity 0.0 seconds Passivity duration used by the generated end-turn.

The item has one predicate-proposition child. It can appear in a plan, postplan, if branch, or a question-parameter hint. Goal propositions and other proposition forms are not supported.

Behavior and usage

With insist="false", an already shared proposition for the same predicate suppresses the inform even if its value differs. With insist="true", the old value for that predicate is forgotten before the new proposition is assumed and informed. Keep multiple informs in one plan on different predicates: informs for the same predicate can interfere with one another.

Use assume_shared to update shared state without requesting an utterance. generate_end_turn="true" is equivalent to adding an end_turn with expected_passivity after the inform.

Examples

Inform a value:

<inform>
  <proposition predicate="first_name" value="Charlie"/>
</inform>

Inform and hand off the turn for three seconds:

<inform generate_end_turn="true" expected_passivity="3.0">
  <proposition predicate="first_name" value="Charlie"/>
</inform>

Omitting expected_passivity uses its 0.0 second default:

<inform generate_end_turn="true">
  <proposition predicate="first_name" value="Charlie"/>
</inform>

For a hint, place the inform in a question's parameters:

<parameters question_type="yn_question" predicate="added_water">
  <hint>
    <inform insist="true">
      <proposition predicate="helpful_information" value="added_water_hint"/>
    </inform>
  </hint>
</parameters>