Slot

  • Slots are represented in JSON format with fields indicating their mode, status, value, update status, and an optional prompt.

  • Developers can define if a slot is required or optional using the mode field and include a custom prompt to guide user input.

  • The value field in the JSON response allows modification of the slot value, directly impacting the slot filling process.

  • A dedicated prompt field allows overriding the default prompt, offering flexibility in guiding user interactions.

Represents a slot.

JSON representation
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Fields
mode

enum (SlotMode)

The mode of the slot (required or optional). Can be set by developer.

status

enum (SlotStatus)

The status of the slot.

value

value (Value format)

The value of the slot. Changing this value in the response, will modify the value in slot filling.

updated

boolean

Indicates if the slot value was collected on the last turn. This field is read-only.

prompt

object (Prompt)

Optional. This prompt is sent to the user when needed to fill a required slot. This prompt overrides the existing prompt defined in the console. This field is not included in the webhook request.