SuggestKnowledgeAssistResponse

The response message for Participants.SuggestKnowledgeAssist.

JSON representation
{
  "knowledgeAssistAnswer": {
    object (KnowledgeAssistAnswer)
  },
  "latestMessage": string,
  "contextSize": integer
}
Fields
knowledgeAssistAnswer

object (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 latestMessage to compile the suggestion. It may be smaller than the SuggestKnowledgeAssistRequest.context_size field in the request if there are fewer messages in the conversation.

KnowledgeAssistAnswer

Represents a Knowledge Assist answer.

JSON representation
{
  "suggestedQuery": {
    object (SuggestedQuery)
  },
  "suggestedQueryAnswer": {
    object (KnowledgeAnswer)
  },
  "answerRecord": string
}
Fields
suggestedQuery

object (SuggestedQuery)

The query suggested based on the context. Suggestion is made only if it is different from the previous suggestion.

suggestedQueryAnswer

object (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>.

SuggestedQuery

Represents a suggested query.

JSON representation
{
  "queryText": string
}
Fields
queryText

string

Suggested query text.

KnowledgeAnswer

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

JSON representation
{
  "answerText": string,

  // Union field source can be only one of the following:
  "faqSource": {
    object (FaqSource)
  },
  "generativeSource": {
    object (GenerativeSource)
  }
  // End of list of possible types for union field source.
}
Fields
answerText

string

The piece of text from the source that answers this suggested query.

Union field source. Source of result. source can be only one of the following:
faqSource

object (FaqSource)

Populated if the prediction came from FAQ.

generativeSource

object (GenerativeSource)

Populated if the prediction was Generative.

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 (Snippet)
    }
  ]
}
Fields
snippets[]

object (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 (Struct format)

Metadata of the document.