# Dialogflow API . projects . agent . sessions . contexts

## Instance Methods

Creates a context.

Deletes the specified context.

Retrieves the specified context.

Returns the list of all contexts in the specified session.

Retrieves the next page of results.

Updates the specified context.

### Method Details

`create(parent, body, x__xgafv=None)`

    Creates a context.

    If the specified context already exists, overrides the context.

    Args:
      parent: string, Required. The session to create a context for.
    Format: `projects//agent/sessions/`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Represents a context.
      "parameters": { # Optional. The collection of parameters associated with this context.
          # Refer to [this
          # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
          # for syntax.
        "a_key": "", # Properties of the object.
      },
      "name": "A String", # Required. The unique identifier of the context. Format:
          # `projects//agent/sessions//contexts/`.
          #
          # 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.
      "lifespanCount": 42, # Optional. The number of conversational query requests after which the
          # context expires. If set to `0` (the default) the context expires
          # immediately. Contexts expire automatically after 20 minutes if there
          # are no matching queries.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents a context.
        "parameters": { # Optional. The collection of parameters associated with this context.
            # Refer to [this
            # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
            # for syntax.
          "a_key": "", # Properties of the object.
        },
        "name": "A String", # Required. The unique identifier of the context. Format:
            # `projects//agent/sessions//contexts/`.
            #
            # 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.
        "lifespanCount": 42, # Optional. The number of conversational query requests after which the
            # context expires. If set to `0` (the default) the context expires
            # immediately. Contexts expire automatically after 20 minutes if there
            # are no matching queries.
      }

`delete(name, x__xgafv=None)`

    Deletes the specified context.

    Args:
      name: string, Required. The name of the context to delete. Format:
    `projects//agent/sessions//contexts/`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated
          # empty messages in your APIs. A typical example is to use it as the request
          # or the response type of an API method. For instance:
          #
          #     service Foo {
          #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`get(name, x__xgafv=None)`

    Retrieves the specified context.

    Args:
      name: string, Required. The name of the context. Format:
    `projects//agent/sessions//contexts/`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents a context.
        "parameters": { # Optional. The collection of parameters associated with this context.
            # Refer to [this
            # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
            # for syntax.
          "a_key": "", # Properties of the object.
        },
        "name": "A String", # Required. The unique identifier of the context. Format:
            # `projects//agent/sessions//contexts/`.
            #
            # 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.
        "lifespanCount": 42, # Optional. The number of conversational query requests after which the
            # context expires. If set to `0` (the default) the context expires
            # immediately. Contexts expire automatically after 20 minutes if there
            # are no matching queries.
      }

`list(parent, pageSize=None, pageToken=None, x__xgafv=None)`

    Returns the list of all contexts in the specified session.

    Args:
      parent: string, Required. The session to list all contexts from.
    Format: `projects//agent/sessions/`. (required)
      pageSize: integer, Optional. The maximum number of items to return in a single page. By
    default 100 and at most 1000.
      pageToken: string, Optional. The next_page_token value returned from a previous list request.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # The response message for Contexts.ListContexts.
        "contexts": [ # The list of contexts. There will be a maximum number of items
            # returned based on the page_size field in the request.
          { # Represents a context.
            "parameters": { # Optional. The collection of parameters associated with this context.
                # Refer to [this
                # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
                # for syntax.
              "a_key": "", # Properties of the object.
            },
            "name": "A String", # Required. The unique identifier of the context. Format:
                # `projects//agent/sessions//contexts/`.
                #
                # 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.
            "lifespanCount": 42, # Optional. The number of conversational query requests after which the
                # context expires. If set to `0` (the default) the context expires
                # immediately. Contexts expire automatically after 20 minutes if there
                # are no matching queries.
          },
        ],
        "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
            # more results in the list.
      }

`list_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.

`patch(name, body, updateMask=None, x__xgafv=None)`

    Updates the specified context.

    Args:
      name: string, Required. The unique identifier of the context. Format:
    `projects//agent/sessions//contexts/`.

    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. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Represents a context.
      "parameters": { # Optional. The collection of parameters associated with this context.
          # Refer to [this
          # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
          # for syntax.
        "a_key": "", # Properties of the object.
      },
      "name": "A String", # Required. The unique identifier of the context. Format:
          # `projects//agent/sessions//contexts/`.
          #
          # 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.
      "lifespanCount": 42, # Optional. The number of conversational query requests after which the
          # context expires. If set to `0` (the default) the context expires
          # immediately. Contexts expire automatically after 20 minutes if there
          # are no matching queries.
    }

      updateMask: string, Optional. The mask to control which fields get updated.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Represents a context.
        "parameters": { # Optional. The collection of parameters associated with this context.
            # Refer to [this
            # doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters)
            # for syntax.
          "a_key": "", # Properties of the object.
        },
        "name": "A String", # Required. The unique identifier of the context. Format:
            # `projects//agent/sessions//contexts/`.
            #
            # 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.
        "lifespanCount": 42, # Optional. The number of conversational query requests after which the
            # context expires. If set to `0` (the default) the context expires
            # immediately. Contexts expire automatically after 20 minutes if there
            # are no matching queries.
      }