- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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. |
servingConfig |
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. |
safeSearch |
Whether to turn on safe search. |
userLabels |
The user labels applied to a resource must meet the following requirements:
See Google Cloud Document for more details. |
summarySpec |
A specification for configuring the summary returned in the response. |
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.