Method: projects.locations.agent.environments.users.sessions.contexts.patch

Updates the specified context.

HTTP request

PATCH https://{endpoint}/v2/{context.name=projects/*/locations/*/agent/environments/*/users/*/sessions/*/contexts/*}

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
context.name

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

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The mask to control which fields get updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Context.

Response body

If successful, the response body contains an instance of Context.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.