Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Session

Required. Holds session data like the session id and session parameters.

Contains information on the current conversation session

Optional. Describes data for the current session, session parameters can be created, updated, or removed by the fulfillment.

Hierarchy

Implemented by

Properties

Optional id

id: string

Required. Globally unique ID of the current conversation session. This field is read-only.

Optional languageCode

languageCode: string

Language of the current conversation session. Follows IETF BCP-47 language code http://www.rfc-editor.org/rfc/bcp/bcp47.txt. This could be different from user locale if the action uses multi-language features. For example, when handler_response.expected.language_code is set, it changes the conversation language for all following turns, which will be reflected in this field.

Optional params

params: object

Required. List of all parameters collected from forms and intents during the session. Key is the parameter name. Parameters defined here will be merged with parameters already defined in the session. Parameters with a null value will be removed from the session.

Type declaration

  • [key: string]: any

Optional typeOverrides

typeOverrides: TypeOverride[]

Optional. Types scoped to the session. Session type defines can supplement or replace existing types. Type names must be unique.

Generated using TypeDoc