Required. The resource name of the Conversation to get. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}. Use projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/- to activate auto session mode, which automatically creates a new conversation inside a conversations.converse session.
Request body
The request body contains data with the following structure:
The resource name of the Serving Config to use. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} If this is not set, the default serving config will be used.
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
safeSearch
boolean
Whether to turn on safe search.
userLabels
map (key: string, value: string)
The user labels applied to a resource must meet the following requirements:
Each resource can have multiple labels, up to a maximum of 64.
Each label must be a key-value pair.
Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
A specification for configuring the summary returned in the response.
filter
string
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'
For more information about filtering including syntax and filter operators, see Filter
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting
[[["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-06-27 UTC."],[[["\u003cp\u003eThis endpoint utilizes a \u003ccode\u003ePOST\u003c/code\u003e request to \u003ccode\u003ehttps://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse\u003c/code\u003e for conversation interactions, employing gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e parameter in the URL is required and specifies the Conversation resource name, with the option to use auto session mode by using a specific format.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes a mandatory \u003ccode\u003equery\u003c/code\u003e field for user input, along with optional fields like \u003ccode\u003eservingConfig\u003c/code\u003e, \u003ccode\u003econversation\u003c/code\u003e, \u003ccode\u003esafeSearch\u003c/code\u003e, \u003ccode\u003euserLabels\u003c/code\u003e, \u003ccode\u003esummarySpec\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eboostSpec\u003c/code\u003e to customize the conversation and search parameters.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests return a \u003ccode\u003eConverseConversationResponse\u003c/code\u003e, and it requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and \u003ccode\u003ediscoveryengine.conversations.converse\u003c/code\u003e IAM permission on the \u003ccode\u003ename\u003c/code\u003e resource.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efilter\u003c/code\u003e and \u003ccode\u003eboostSpec\u003c/code\u003e fields provide options to refine the search results, and consequently, the converse response, by allowing specific filtering and boosting criteria.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.collections.engines.conversations.converse\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n\nConverses a conversation.\n\n### HTTP request\n\n`POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [ConverseConversationResponse](/generative-ai-app-builder/docs/reference/rest/v1alpha/ConverseConversationResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `discoveryengine.conversations.converse`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]