- [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SCHEMA_REPRESENTATION)
- [KnowledgeAssistAnswer](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistAnswer)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistAnswer.SCHEMA_REPRESENTATION)
- [SuggestedQuery](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SuggestedQuery)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SuggestedQuery.SCHEMA_REPRESENTATION)
- [SearchContext](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SearchContext)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SearchContext.SCHEMA_REPRESENTATION)
- [KnowledgeAnswer](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAnswer)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAnswer.SCHEMA_REPRESENTATION)
- [FaqSource](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#FaqSource)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#FaqSource.SCHEMA_REPRESENTATION)
- [GenerativeSource](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource.SCHEMA_REPRESENTATION)
- [Snippet](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#Snippet)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#Snippet.SCHEMA_REPRESENTATION)
- [EventSource](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#EventSource)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#EventSource.SCHEMA_REPRESENTATION)
- [KnowledgeAssistDebugInfo](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistDebugInfo)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistDebugInfo.SCHEMA_REPRESENTATION)
- [QueryGenerationFailureReason](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationFailureReason)
- [QueryCategorizationFailureReason](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryCategorizationFailureReason)
- [KnowledgeAssistBehavior](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistBehavior)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistBehavior.SCHEMA_REPRESENTATION)
- [QueryGenerationDebugInfo](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationDebugInfo)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationDebugInfo.SCHEMA_REPRESENTATION)
- [AdditionalSuggestedQueryResult](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#AdditionalSuggestedQueryResult)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#AdditionalSuggestedQueryResult.SCHEMA_REPRESENTATION)

The response message for `https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.conversations.participants.suggestions/suggestKnowledgeAssist#google.cloud.dialogflow.v2beta1.Participants.SuggestKnowledgeAssist`.

| JSON representation |
|---|
| ``` { "knowledgeAssistAnswer": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistAnswer`) }, "latestMessage": string, "contextSize": integer, "additionalSuggestedQueryResults": [ { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#AdditionalSuggestedQueryResult`) } ] } ``` |

| Fields ||
|---|---|
| `knowledgeAssistAnswer` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistAnswer`)`` Output only. Knowledge Assist suggestion. |
| `latestMessage` | `string` The name of the latest conversation message used to compile suggestion for. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>`. |
| `contextSize` | `integer` Number of messages prior to and including `https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#FIELDS.latest_message` to compile the suggestion. It may be smaller than the `https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/projects.conversations.participants.suggestions/suggestKnowledgeAssist#body.request_body.FIELDS.context_size` field in the request if there are fewer messages in the conversation. |
| `additionalSuggestedQueryResults[]` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#AdditionalSuggestedQueryResult`)`` Optional. The list of additional suggested queries based on the context. This is used for the cases when we want to generate multiple queries for a single request. |

## KnowledgeAssistAnswer

Represents a Knowledge Assist answer.

| JSON representation |
|---|
| ``` { "suggestedQuery": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SuggestedQuery`) }, "suggestedQueryAnswer": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAnswer`) }, "answerRecord": string, "knowledgeAssistDebugInfo": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistDebugInfo`) } } ``` |

| Fields ||
|---|---|
| `suggestedQuery` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SuggestedQuery`)`` The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion. |
| `suggestedQueryAnswer` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAnswer`)`` The answer generated for the suggested query. Whether or not an answer is generated depends on how confident we are about the generated query. |
| `answerRecord` | `string` The name of the answer record. Format: `projects/<Project ID>/locations/<location ID>/answer Records/<Answer Record ID>`. |
| `knowledgeAssistDebugInfo` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistDebugInfo`)`` Debug information related to Knowledge Assist feature. |

## SuggestedQuery

Represents a suggested query.

| JSON representation |
|---|
| ``` { "queryText": string, "searchContexts": [ { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SearchContext`) } ] } ``` |

| Fields ||
|---|---|
| `queryText` | `string` Suggested query text. |
| `searchContexts[]` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SearchContext`)`` Optional. The search contexts for the query. |

## SearchContext

Search context is information useful for knowledge search that helps enrich the query. Example: search_context { key: "application name" value: "DesignApp" }

| JSON representation |
|---|
| ``` { "key": string, "value": string } ``` |

| Fields ||
|---|---|
| `key` | `string` Optional. The key of the search context, e.g. "application name". |
| `value` | `string` Optional. The value of the search context, e.g. "DesignApp". |

## KnowledgeAnswer

Represents an answer from Knowledge. Currently supports FAQ and Generative answers.

| JSON representation |
|---|
| ``` { "answerText": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "faqSource": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#FaqSource`) }, "generativeSource": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource`) }, "playbookSource": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource`) }, "eventSource": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#EventSource`) } // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| `answerText` | `string` The piece of text from the `source` that answers this suggested query. |
| Source of result. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `faqSource` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#FaqSource`)`` Populated if the prediction came from FAQ. |
| `generativeSource` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource`)`` Populated if the prediction was Generative. |
| `playbookSource` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource`)`` Populated if the prediction was from Playbook. |
| `eventSource` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#EventSource`)`` Populated if the prediction was from an event. |
| End of mutually exclusive fields. ||

## FaqSource

Details about source of FAQ answer.

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

| Fields ||
|---|---|
| `question` | `string` The corresponding FAQ question. |

## GenerativeSource

Details about source of Generative answer.

| JSON representation |
|---|
| ``` { "snippets": [ { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#Snippet`) } ] } ``` |

| Fields ||
|---|---|
| `snippets[]` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#Snippet`)`` All snippets used for this Generative Prediction, with their source URI and data. |

## Snippet

Snippet Source for a Generative Prediction.

| JSON representation |
|---|
| ``` { "uri": string, "text": string, "title": string, "metadata": { object } } ``` |

| Fields ||
|---|---|
| `uri` | `string` URI the data is sourced from. |
| `text` | `string` Text taken from that URI. |
| `title` | `string` Title of the document. |
| `metadata` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Metadata of the document. |

## EventSource

Details about source of Event answer.

| JSON representation |
|---|
| ``` { "event": string, "snippets": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource`) } } ``` |

| Fields ||
|---|---|
| `event` | `string` Name of the triggered event. |
| `snippets` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#GenerativeSource`)`` Sources used in event fulfillment. |

## KnowledgeAssistDebugInfo

Debug information related to Knowledge Assist feature.

| JSON representation |
|---|
| ``` { "queryGenerationFailureReason": enum (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationFailureReason`), "queryCategorizationFailureReason": enum (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryCategorizationFailureReason`), "datastoreResponseReason": enum (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/DatastoreResponseReason`), "knowledgeAssistBehavior": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistBehavior`) }, "ingestedContextReferenceDebugInfo": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/IngestedContextReferenceDebugInfo`) }, "serviceLatency": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/ServiceLatency`) }, "queryGenerationDebugInfo": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationDebugInfo`) }, "cesDebugInfo": { object } } ``` |

| Fields ||
|---|---|
| `queryGenerationFailureReason` | ``enum (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationFailureReason`)`` Reason for query generation. |
| `queryCategorizationFailureReason` | ``enum (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryCategorizationFailureReason`)`` Reason for query categorization. |
| `datastoreResponseReason` | ``enum (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/DatastoreResponseReason`)`` Response reason from datastore which indicates data serving status or answer quality degradation. |
| `knowledgeAssistBehavior` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#KnowledgeAssistBehavior`)`` Configured behaviors for Knowedge Assist. |
| `ingestedContextReferenceDebugInfo` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/IngestedContextReferenceDebugInfo`)`` Information about parameters ingested for search knowledge. |
| `serviceLatency` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/ServiceLatency`)`` The latency of the service. |
| `queryGenerationDebugInfo` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#QueryGenerationDebugInfo`)`` Debug information and model metadata for query generation. |
| `cesDebugInfo` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Debug information from CES runtime API. |

## QueryGenerationFailureReason

Reason for query generation failure.

| Enums ||
|---|---|
| `QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED` | Default value. |
| `QUERY_GENERATION_OUT_OF_QUOTA` | Query generation is blocked due to out of quota. |
| `QUERY_GENERATION_FAILED` | Call to Knowedge Assist query generation model fails. |
| `QUERY_GENERATION_NO_QUERY_GENERATED` | Query generation model decides that there is no new topic change or there has been similar queries generated in the previous turns. |
| `QUERY_GENERATION_RAI_FAILED` | Knowedge Assist generated query is blocked by RAI (Responsible AI). |
| `NOT_IN_ALLOWLIST` | Query generation is blocked by Knowledge Assist conversation profile level / agent id level filtering. |
| `QUERY_GENERATION_QUERY_REDACTED` | The generated query is blocked due to redaction. |
| `QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED` | Query generation failed due to LLM response parse failure. |
| `QUERY_GENERATION_EMPTY_CONVERSATION` | The conversation has no messages. |
| `QUERY_GENERATION_EMPTY_LAST_MESSAGE` | The last message in the conversation is empty. |
| `QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET` | The trigger event condition is not met. This occurs in the following scenarios: 1. The triggerEvent is CUSTOMER_MESSAGE or UNSPECIFIED, but the last message is not from the customer. 2. The triggerEvent is AGENT_MESSAGE, but the last message is not from the agent. |

## QueryCategorizationFailureReason

Reason for query categorization failure.

| Enums ||
|---|---|
| `QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED` | Default value. |
| `QUERY_CATEGORIZATION_INVALID_CONFIG` | Vertex AI Search config supplied for query categorization is invalid. |
| `QUERY_CATEGORIZATION_RESULT_NOT_FOUND` | Vertex AI Search result does not contain a query categorization result. |
| `QUERY_CATEGORIZATION_FAILED` | Vertex AI Search call fails. |

## KnowledgeAssistBehavior

Configured behaviors for Knowedge Assist.

| JSON representation |
|---|
| ``` { "answerGenerationRewriterOn": boolean, "endUserMetadataIncluded": boolean, "returnQueryOnly": boolean, "usePubsubDelivery": boolean, "disableSyncDelivery": boolean, "previousQueriesIncluded": boolean, "useTranslatedMessage": boolean, "useCustomSafetyFilterLevel": boolean, "conversationTranscriptHasMixedLanguages": boolean, "queryGenerationAgentLanguageMismatch": boolean, "queryGenerationEndUserLanguageMismatch": boolean, "thirdPartyConnectorAllowed": boolean, "multipleQueriesGenerated": boolean, "queryContainedSearchContext": boolean, "invalidItemsQuerySuggestionSkipped": boolean, "primaryQueryRedactedAndReplaced": boolean, "appendedSearchContextCount": integer } ``` |

| Fields ||
|---|---|
| `answerGenerationRewriterOn` | `boolean` Whether data store agent rewriter was turned off for the request. |
| `endUserMetadataIncluded` | `boolean` Whether endUserMetadata is included in the data store agent call. |
| `returnQueryOnly` | `boolean` Whether customers configured to return query only in the conversation profile. |
| `usePubsubDelivery` | `boolean` Whether customers configured to use pubsub to deliver. |
| `disableSyncDelivery` | `boolean` Whether customers configured to disable the synchronous delivery of Knowedge Assist response. |
| `previousQueriesIncluded` | `boolean` Whether previously suggested queries are included in the query generation process. |
| `useTranslatedMessage` | `boolean` Translated message is included in query generation process. |
| `useCustomSafetyFilterLevel` | `boolean` Safety filter is adjusted by user. |
| `conversationTranscriptHasMixedLanguages` | `boolean` Conversation transcript has mixed languages. |
| `queryGenerationAgentLanguageMismatch` | `boolean` Whether the agent language from the translation generator mismatches the end-user language. |
| `queryGenerationEndUserLanguageMismatch` | `boolean` Whether the end-user language from the translation generator mismatches the end-user language. |
| `thirdPartyConnectorAllowed` | `boolean` This field indicates whether third party connectors are enabled for the project. |
| `multipleQueriesGenerated` | `boolean` Indicates that the query generation model generated multiple queries. |
| `queryContainedSearchContext` | `boolean` Indicates that the generated query contains search context. |
| `invalidItemsQuerySuggestionSkipped` | `boolean` Indicates that invalid items were skipped when parsing the LLM response. |
| `primaryQueryRedactedAndReplaced` | `boolean` True if the primary suggested query was redacted and replaced by an additional query. |
| `appendedSearchContextCount` | `integer` The number of search contexts appended to the query. |

## QueryGenerationDebugInfo

Debug information and model metadata for query generation.

| JSON representation |
|---|
| ``` { "promptTokenCount": integer, "candidatesTokenCount": integer, "totalTokenCount": integer, "thinkingLevel": string, "thinkingBudgetTokens": integer, "similarityToLastQuery": number, "similarityToLastQueryThreshold": number } ``` |

| Fields ||
|---|---|
| `promptTokenCount` | `integer` The total number of tokens in the prompt. |
| `candidatesTokenCount` | `integer` The total number of tokens in the generated candidates. |
| `totalTokenCount` | `integer` The total number of tokens for the entire request. |
| `thinkingLevel` | `string` The thinking level configured for the Gemini model. |
| `thinkingBudgetTokens` | `integer` The thinking budget (in number of tokens) configured for the Gemini model. |
| `similarityToLastQuery` | `number` The similarity score of the suggested query to the last suggested query. |
| `similarityToLastQueryThreshold` | `number` The similarity threshold used to filter out queries similar to the last suggestion. |

## AdditionalSuggestedQueryResult

Represents a single suggested query result.

| JSON representation |
|---|
| ``` { "suggestedQuery": { object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SuggestedQuery`) }, "answerRecord": string } ``` |

| Fields ||
|---|---|
| `suggestedQuery` | ``object (`https://docs.cloud.google.com/dialogflow/es/docs/reference/rest/v2beta1/SuggestKnowledgeAssistResponse#SuggestedQuery`)`` Output only. The suggested query based on the context. |
| `answerRecord` | `string` Output only. The name of the answer record. Format: `projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>` |