Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
If you might use Agent Assist or other CCAI products now or in the future, consider using AnalyzeContent instead of sessions.detectIntent. AnalyzeContent has additional functionality for Agent Assist and other CCAI products.
Required. The name of the session this query is sent to. Format: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User
ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default 'draft' environment (Environment ID might be referred to as environment name at some places). If User ID is not specified, we are using "-". It's up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.
Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.
The natural language speech audio to be processed. This field should be populated iff queryInput is set to an input audio config. A single request can contain up to 1 minute of speech audio data.
[[["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-05 UTC."],[[["This document outlines how to use the `detectIntent` method to process natural language queries and receive structured data, noting that it's non-idempotent due to potential updates to contexts and session entity types."],["The HTTP request to use this method is a `POST` request to a specific endpoint, including a dynamic `session` path parameter that must be formatted as a project ID and session ID or more depending on whether you use agent versions and environments."],["The request body requires parameters like `queryParams`, `queryInput`, `outputAudioConfig`, `outputAudioConfigMask`, and `inputAudio`, all with specific formatting and usage rules."],["Successful calls to `detectIntent` return a response body structured as a `DetectIntentResponse`, detailed in a separate linked document."],["To use the `detectIntent` method, one of two specific OAuth scopes must be authorized: `https://www.googleapis.com/auth/cloud-platform` or `https://www.googleapis.com/auth/dialogflow`."]]],[]]