Method: projects.locations.collections.dataStores.conversations.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a Conversation.
Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
HTTP request
PATCH https://discoveryengine.googleapis.com/v1/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
conversation.name |
string
Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* or projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Indicates which fields in the provided Conversation to update. The following are NOT supported:
If not set or empty, all supported fields are 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 Conversation.
Response body
If successful, the response body contains an instance of Conversation.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the name resource:
discoveryengine.conversations.update
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This page details how to update a Conversation resource using a PATCH request, which cannot alter the Conversation action type and returns a NOT_FOUND error if the specified Conversation does not exist."],["The HTTP request utilizes a `PATCH` method directed at a specific URL structure involving projects, locations, collections, data stores, and conversations within Google's Discovery Engine API."],["Required path parameters for the request include `conversation.name`, a fully qualified string indicating the specific Conversation resource to be updated."],["The `updateMask` query parameter is used to specify which fields within the Conversation resource should be updated, with unsupported fields like Conversation.name, and if not specified, all supported fields are updated."],["The request body must contain an instance of a Conversation resource, and a successful response returns an updated Conversation resource, while also requiring the `discoveryengine.conversations.update` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
