- [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SCHEMA_REPRESENTATION)
- [SentimentAnalysisResult](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SentimentAnalysisResult)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SentimentAnalysisResult.SCHEMA_REPRESENTATION)
- [DataStoreConnectionSignals](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#DataStoreConnectionSignals)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#DataStoreConnectionSignals.SCHEMA_REPRESENTATION)
- [RewriterModelCallSignals](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#RewriterModelCallSignals)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#RewriterModelCallSignals.SCHEMA_REPRESENTATION)
- [SearchSnippet](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SearchSnippet)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SearchSnippet.SCHEMA_REPRESENTATION)
- [AnswerGenerationModelCallSignals](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerGenerationModelCallSignals)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerGenerationModelCallSignals.SCHEMA_REPRESENTATION)
- [AnswerPart](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerPart)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerPart.SCHEMA_REPRESENTATION)
- [CitedSnippet](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#CitedSnippet)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#CitedSnippet.SCHEMA_REPRESENTATION)
- [GroundingSignals](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingSignals)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingSignals.SCHEMA_REPRESENTATION)
- [GroundingDecision](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingDecision)
- [GroundingScoreBucket](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingScoreBucket)
- [SafetySignals](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetySignals)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetySignals.SCHEMA_REPRESENTATION)
- [SafetyDecision](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetyDecision)
- [BannedPhraseMatch](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#BannedPhraseMatch)
- [TraceBlock](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#TraceBlock)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#TraceBlock.SCHEMA_REPRESENTATION)
- [PlaybookTraceMetadata](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#PlaybookTraceMetadata)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#PlaybookTraceMetadata.SCHEMA_REPRESENTATION)
- [FlowTraceMetadata](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#FlowTraceMetadata)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#FlowTraceMetadata.SCHEMA_REPRESENTATION)
- [SpeechProcessingMetadata](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SpeechProcessingMetadata)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SpeechProcessingMetadata.SCHEMA_REPRESENTATION)

Represents the result of a conversational query.

| JSON representation |
|---|
| ``` { "languageCode": string, "parameters": { object }, "responseMessages": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#ResponseMessage`) } ], "webhookStatuses": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Status`) } ], "webhookPayloads": [ { object } ], "currentPage": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows.pages#Page`) }, "currentFlow": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows#Flow`) }, "intent": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.intents#Intent`) }, "intentDetectionConfidence": number, "match": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Match`) }, "diagnosticInfo": { object }, "sentimentAnalysisResult": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SentimentAnalysisResult`) }, "advancedSettings": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/AdvancedSettings`) }, "allowAnswerFeedback": boolean, "dataStoreConnectionSignals": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#DataStoreConnectionSignals`) }, "traceBlocks": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#TraceBlock`) } ], // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "triggerIntent": string, "transcript": string, "triggerEvent": string, "dtmf": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#DtmfInput`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `languageCode` | `string` The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. |
| `parameters` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` The collected `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/SessionInfo#FIELDS.parameters`. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: If parameter's entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. - MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value. |
| `responseMessages[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Fulfillment#ResponseMessage`)`` The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic. |
| `webhookStatuses[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Status`)`` The list of webhook call status in the order of call sequence. |
| `webhookPayloads[]` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` The list of webhook payload in `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse#FIELDS.payload`, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead. |
| `currentPage` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows.pages#Page`)`` The current `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows.pages#Page`. Some, not all fields are filled in this message, including but not limited to `name` and `displayName`. |
| `currentFlow` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows#Flow`)`` The current `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.flows#Flow`. Some, not all fields are filled in this message, including but not limited to `name` and `displayName`. |
| `intent (deprecated)` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.intents#Intent`)`` > [!WARNING] > This item is deprecated! The `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.intents#Intent` that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `displayName`. This field is deprecated, please use `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#FIELDS.match` instead. |
| `intentDetectionConfidence (deprecated)` | `number` > [!WARNING] > This item is deprecated! The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#FIELDS.match` instead. |
| `match` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/Match`)`` Intent match result, could be an intent or an event. |
| `diagnosticInfo` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure. One of the fields is called "Alternative Matched Intents", which may aid with debugging. The following describes these intent results: - The list is empty if no intent was matched to end-user input. - Only intents that are referenced in the currently active flow are included. - The matched intent is included. - Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope), are included. - Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score. |
| `sentimentAnalysisResult` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SentimentAnalysisResult`)`` The sentiment analyss result, which depends on `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryParameters#FIELDS.analyze_query_text_sentiment`, specified in the request. |
| `advancedSettings` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/AdvancedSettings`)`` Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding. |
| `allowAnswerFeedback` | `boolean` Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget. |
| `dataStoreConnectionSignals` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#DataStoreConnectionSignals`)`` Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query. |
| `traceBlocks[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#TraceBlock`)`` Optional. Contains the sequence of trace blocks from the current conversation turn. Trace blocks are ordered chronologically and contain detailed traces of runtime behavior such as tool calls, LLM calls, flow and playbook invocations, agent utterances and user utterances. |
| The original conversational query. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `text` | `string` If `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#TextInput` was provided as input, this field will contain a copy of the text. |
| `triggerIntent` | `string` If an `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#IntentInput` was provided as input, this field will contain a copy of the intent identifier. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`. |
| `transcript` | `string` If `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#AudioInput` was provided as input, this field will contain the transcript for the audio. |
| `triggerEvent` | `string` If an `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#EventInput` was provided as input, this field will contain the name of the event. |
| `dtmf` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#DtmfInput`)`` If a `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#DtmfInput` was provided as input, this field will contain a copy of the `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ConversationTurn#DtmfInput`. |
| End of mutually exclusive fields. ||

## SentimentAnalysisResult

The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.

| JSON representation |
|---|
| ``` { "score": number, "magnitude": number } ``` |

| Fields ||
|---|---|
| `score` | `number` Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). |
| `magnitude` | `number` A non-negative number in the \[0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). |

## DataStoreConnectionSignals

Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...

| JSON representation |
|---|
| ``` { "rewriterModelCallSignals": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#RewriterModelCallSignals`) }, "rewrittenQuery": string, "searchSnippets": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SearchSnippet`) } ], "answerGenerationModelCallSignals": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerGenerationModelCallSignals`) }, "answer": string, "answerParts": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerPart`) } ], "citedSnippets": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#CitedSnippet`) } ], "groundingSignals": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingSignals`) }, "safetySignals": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetySignals`) } } ``` |

| Fields ||
|---|---|
| `rewriterModelCallSignals` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#RewriterModelCallSignals`)`` Optional. Diagnostic info related to the rewriter model call. |
| `rewrittenQuery` | `string` Optional. Rewritten string query used for search. |
| `searchSnippets[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SearchSnippet`)`` Optional. Search snippets included in the answer generation prompt. |
| `answerGenerationModelCallSignals` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerGenerationModelCallSignals`)`` Optional. Diagnostic info related to the answer generation model call. |
| `answer` | `string` Optional. The final compiled answer. |
| `answerParts[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#AnswerPart`)`` Optional. Answer parts with relevant citations. Concatenation of texts should add up the `answer` (not counting whitespaces). |
| `citedSnippets[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#CitedSnippet`)`` Optional. Snippets cited by the answer generation model from the most to least relevant. |
| `groundingSignals` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingSignals`)`` Optional. Grounding signals. |
| `safetySignals` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetySignals`)`` Optional. Safety check result. |

## RewriterModelCallSignals

Diagnostic info related to the rewriter model call.

| JSON representation |
|---|
| ``` { "renderedPrompt": string, "modelOutput": string, "model": string } ``` |

| Fields ||
|---|---|
| `renderedPrompt` | `string` Prompt as sent to the model. |
| `modelOutput` | `string` Output of the generative model. |
| `model` | `string` Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |

## SearchSnippet

Search snippet details.

| JSON representation |
|---|
| ``` { "documentTitle": string, "documentUri": string, "text": string, "metadata": { object } } ``` |

| Fields ||
|---|---|
| `documentTitle` | `string` Title of the enclosing document. |
| `documentUri` | `string` Uri for the document. Present if specified for the document. |
| `text` | `string` Text included in the prompt. |
| `metadata` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Metadata associated with the document. |

## AnswerGenerationModelCallSignals

Diagnostic info related to the answer generation model call.

| JSON representation |
|---|
| ``` { "renderedPrompt": string, "modelOutput": string, "model": string } ``` |

| Fields ||
|---|---|
| `renderedPrompt` | `string` Prompt as sent to the model. |
| `modelOutput` | `string` Output of the generative model. |
| `model` | `string` Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. |

## AnswerPart

Answer part with citation.

| JSON representation |
|---|
| ``` { "text": string, "supportingIndices": [ integer ] } ``` |

| Fields ||
|---|---|
| `text` | `string` Substring of the answer. |
| `supportingIndices[]` | `integer` Citations for this answer part. Indices of `searchSnippets`. |

## CitedSnippet

Snippet cited by the answer generation model.

| JSON representation |
|---|
| ``` { "searchSnippet": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SearchSnippet`) }, "snippetIndex": integer } ``` |

| Fields ||
|---|---|
| `searchSnippet` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SearchSnippet`)`` Details of the snippet. |
| `snippetIndex` | `integer` Index of the snippet in `searchSnippets` field. |

## GroundingSignals

Grounding signals.

| JSON representation |
|---|
| ``` { "decision": enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingDecision`), "score": enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingScoreBucket`) } ``` |

| Fields ||
|---|---|
| `decision` | ``enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingDecision`)`` Represents the decision of the grounding check. |
| `score` | ``enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#GroundingScoreBucket`)`` Grounding score bucket setting. |

## GroundingDecision

Represents the decision of the grounding check.

| Enums ||
|---|---|
| `GROUNDING_DECISION_UNSPECIFIED` | Decision not specified. |
| `ACCEPTED_BY_GROUNDING` | Grounding have accepted the answer. |
| `REJECTED_BY_GROUNDING` | Grounding have rejected the answer. |

## GroundingScoreBucket

Grounding score buckets.

| Enums ||
|---|---|
| `GROUNDING_SCORE_BUCKET_UNSPECIFIED` | Score not specified. |
| `VERY_LOW` | We have very low confidence that the answer is grounded. |
| `LOW` | We have low confidence that the answer is grounded. |
| `MEDIUM` | We have medium confidence that the answer is grounded. |
| `HIGH` | We have high confidence that the answer is grounded. |
| `VERY_HIGH` | We have very high confidence that the answer is grounded. |

## SafetySignals

Safety check results.

| JSON representation |
|---|
| ``` { "decision": enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetyDecision`), "bannedPhraseMatch": enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#BannedPhraseMatch`), "matchedBannedPhrase": string } ``` |

| Fields ||
|---|---|
| `decision` | ``enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SafetyDecision`)`` Safety decision. |
| `bannedPhraseMatch` | ``enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#BannedPhraseMatch`)`` Specifies banned phrase match subject. |
| `matchedBannedPhrase` | `string` The matched banned phrase if there was a match. |

## SafetyDecision

Safety decision. All kinds of check are incorporated into this final decision, including banned phrases check.

| Enums ||
|---|---|
| `SAFETY_DECISION_UNSPECIFIED` | Decision not specified. |
| `ACCEPTED_BY_SAFETY_CHECK` | No manual or automatic safety check fired. |
| `REJECTED_BY_SAFETY_CHECK` | One ore more safety checks fired. |

## BannedPhraseMatch

Specifies banned phrase match subject.

| Enums ||
|---|---|
| `BANNED_PHRASE_MATCH_UNSPECIFIED` | No banned phrase check was executed. |
| `BANNED_PHRASE_MATCH_NONE` | All banned phrase checks led to no match. |
| `BANNED_PHRASE_MATCH_QUERY` | A banned phrase matched the query. |
| `BANNED_PHRASE_MATCH_RESPONSE` | A banned phrase matched the response. |

## TraceBlock

The trace block tracks a sequence of actions taken by the agent in a flow or a playbook.

| JSON representation |
|---|
| ``` { "actions": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.playbooks.examples#Example.Action`) } ], "startTime": string, "completeTime": string, "inputParameters": { object }, "outputParameters": { object }, "endState": enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.playbooks.examples#Example.OutputState`), // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "playbookTraceMetadata": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#PlaybookTraceMetadata`) }, "flowTraceMetadata": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#FlowTraceMetadata`) }, "speechProcessingMetadata": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SpeechProcessingMetadata`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `actions[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.playbooks.examples#Example.Action`)`` The actions performed by the agent and the user during this session. |
| `startTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp of the start of the trace block. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `completeTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp of the end of the trace block. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `inputParameters` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Optional. A list of input parameters of the trace block. |
| `outputParameters` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Optional. A list of output parameters of the trace block. |
| `endState` | ``enum (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.playbooks.examples#Example.OutputState`)`` Optional. Output only. The end state of the trace block. |
| Metadata of the trace. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `playbookTraceMetadata` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#PlaybookTraceMetadata`)`` Metadata of the playbook trace. |
| `flowTraceMetadata` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#FlowTraceMetadata`)`` Metadata of the flow trace. |
| `speechProcessingMetadata` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/QueryResult#SpeechProcessingMetadata`)`` Metadata of the speech-to-text and speech-to-text processing. |
| End of mutually exclusive fields. ||

## PlaybookTraceMetadata

Metadata of the playbook trace.

| JSON representation |
|---|
| ``` { "playbook": string, "displayName": string } ``` |

| Fields ||
|---|---|
| `playbook` | `string` Required. The unique identifier of the playbook. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`. |
| `displayName` | `string` Output only. The display name of the playbook. |

## FlowTraceMetadata

Metadata of the flow trace.

| JSON representation |
|---|
| ``` { "flow": string, "displayName": string } ``` |

| Fields ||
|---|---|
| `flow` | `string` Required. The unique identifier of the flow. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`. |
| `displayName` | `string` Output only. The display name of the flow. |

## SpeechProcessingMetadata

Metadata of the speech-to-text and text-to-speech processing.

| JSON representation |
|---|
| ``` { "displayName": string } ``` |

| Fields ||
|---|---|
| `displayName` | `string` Output only. The display name of the speech processing. |