Suggestion

Stay organized with collections Save and categorize content based on your preferences.

Represents a suggestion for a human agent.

JSON representation
{
  "name": string,
  "articles": [
    {
      object (Article)
    }
  ],
  "faqAnswers": [
    {
      object (FaqAnswer)
    }
  ],
  "createTime": string,
  "latestMessage": string
}
Fields
name

string

Output only. The name of this suggestion. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/*/suggestions/<Suggestion ID>.

articles[]

object (Article)

Output only. Articles ordered by score in descending order.

faqAnswers[]

object (FaqAnswer)

Output only. Answers extracted from FAQ documents.

createTime

string (Timestamp format)

Output only. The time the suggestion was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

latestMessage

string

Output only. Latest message used as context to compile this suggestion.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

Article

Represents suggested article.

JSON representation
{
  "title": string,
  "uri": string,
  "snippets": [
    string
  ],
  "metadata": {
    string: string,
    ...
  },
  "answerRecord": string
}
Fields
title

string

Output only. The article title.

uri

string

Output only. The article URI.

snippets[]

string

Output only. Article snippets.

metadata

map (key: string, value: string)

Output only. A map that contains metadata about the answer and the document from which it originates.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

answerRecord

string

Output only. The name of answer record, in the format of "projects//locations//answerRecords/"

FaqAnswer

Represents suggested answer from "frequently asked questions".

JSON representation
{
  "answer": string,
  "confidence": number,
  "question": string,
  "source": string,
  "metadata": {
    string: string,
    ...
  },
  "answerRecord": string
}
Fields
answer

string

Output only. The piece of text from the source knowledge base document.

confidence

number

The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).

question

string

Output only. The corresponding FAQ question.

source

string

Output only. Indicates which Knowledge Document this answer was extracted from. Format: projects/<Project ID>/locations/<Location ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.

metadata

map (key: string, value: string)

Output only. A map that contains metadata about the answer and the document from which it originates.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

answerRecord

string

Output only. The name of answer record, in the format of "projects//locations//answerRecords/"