# Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Context (v1.16.1)

1.16.1 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.1 1.11.0 1.10.1 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.1 1.0.0 0.34.0 0.33.0 0.32.2 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.1 0.16.0 0.15.2 0.14.0 0.13.0 0.12.0 Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Context.

Dialogflow contexts are similar to natural language context. If a person says
to you "they are orange", you need context in order to understand what "they"
is referring to. Similarly, for Dialogflow to handle an end-user expression
like that, it needs to be provided with context in order to correctly match
an intent.


Using contexts, you can control the flow of a conversation. You can configure
contexts for an intent by setting input and output contexts, which are
identified by string names. When an intent is matched, any configured output
contexts for that intent become active. While any contexts are active,
Dialogflow is more likely to match intents that are configured with input
contexts that correspond to the currently active contexts.

<br />

For more information about context, see the
[Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #lifespan_count

    def lifespan_count() -> ::Integer

**Returns**

- (::Integer) --- Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

### #lifespan_count=

    def lifespan_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.
**Returns**

- (::Integer) --- Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Required. The unique identifier of the context. Format:
  `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
  or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
  ID>/sessions/<Session ID>/contexts/<Context ID>`.

  The `Context ID` is always converted to lowercase, may only contain
  characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.

  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.

  The following context names are reserved for internal use by Dialogflow.
  You should not use these contexts or create contexts with these names:
  - `__system_counters__`
  - `*_id_dialog_context`
  - `*_dialog_params_size`

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) ---

  Required. The unique identifier of the context. Format:
  `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
  or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
  ID>/sessions/<Session ID>/contexts/<Context ID>`.

  The `Context ID` is always converted to lowercase, may only contain
  characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.

  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.

  The following context names are reserved for internal use by Dialogflow.
  You should not use these contexts or create contexts with these names:
  - `__system_counters__`
  - `*_id_dialog_context`
  - `*_dialog_params_size`
**Returns**

- (::String) --- Required. The unique identifier of the context. Format:
  `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
  or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
  ID>/sessions/<Session ID>/contexts/<Context ID>`.

  The `Context ID` is always converted to lowercase, may only contain
  characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.

  If `Environment ID` is not specified, we assume default 'draft'
  environment. If `User ID` is not specified, we assume default '-' user.

  The following context names are reserved for internal use by Dialogflow.
  You should not use these contexts or create contexts with these names:
  - `__system_counters__`
  - `*_id_dialog_context`
  - `*_dialog_params_size`

### #parameters

    def parameters() -> ::Google::Protobuf::Struct

**Returns**

- ([::Google::Protobuf::Struct](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Struct)) ---

  Optional. The collection of parameters associated with this context.

  Depending on your protocol or client library language, this is a
  map, associative array, symbol table, dictionary, or JSON object
  composed of a collection of (MapKey, MapValue) pairs:
  - MapKey type: string
  - MapKey value: parameter name
  - MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  - MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

### #parameters=

    def parameters=(value) -> ::Google::Protobuf::Struct

**Parameter**

- **value** ([::Google::Protobuf::Struct](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Struct)) ---

  Optional. The collection of parameters associated with this context.

  Depending on your protocol or client library language, this is a
  map, associative array, symbol table, dictionary, or JSON object
  composed of a collection of (MapKey, MapValue) pairs:
  - MapKey type: string
  - MapKey value: parameter name
  - MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  - MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
**Returns**

- ([::Google::Protobuf::Struct](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-dialogflow-v2/latest/Google-Protobuf-Struct)) ---

  Optional. The collection of parameters associated with this context.

  Depending on your protocol or client library language, this is a
  map, associative array, symbol table, dictionary, or JSON object
  composed of a collection of (MapKey, MapValue) pairs:
  - MapKey type: string
  - MapKey value: parameter name
  - MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  - MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.