Converses a conversation.
HTTP request
POST https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The resource name of the Conversation to get. Format: |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "query": { object ( |
Fields | |
---|---|
query |
Required. Current user input. |
serving |
The resource name of the Serving Config to use. Format: |
conversation |
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. |
safe |
Whether to turn on safe search. |
user |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
summary |
A specification for configuring the summary returned in the response. |
filter |
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 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 |
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting |
Response body
If successful, the response body contains an instance of ConverseConversationResponse
.
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.converse
For more information, see the IAM documentation.