REST Resource: projects.locations.faqModels.faqEntries

Resource: FaqEntry

The FAQ entry resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "question": string,
  "createTime": string,
  "updateTime": string,
  "representativeConversationNames": [
    string
  ],
  "trainingStats": {
    object (Stats)
  },
  "botAnswers": [
    {
      object (BotAnswer)
    }
  ],
  "insightsAnswers": [
    {
      object (InsightsAnswer)
    }
  ],
  "representativeConversations": [
    {
      object (RepresentativeConversation)
    }
  ]
}
Fields
name

string

Immutable. The resource name of the FAQ entry. Format: projects/{project}/locations/{location}/faqModels/{faqModel}/faqEntries/{faqEntry}
displayName

string

Representative name of the FAQ entry, typically the question text.
question

string

Output only. Question of the FAQ.
createTime

string (Timestamp format)

Output only. FAQ entry creation time.

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".
updateTime

string (Timestamp format)

Output only. FAQ entry last update time.

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".
representativeConversationNames[]
(deprecated)

string

Output only. Resource names of the most representative conversations matched. Format: projects/{project}/locations/{location}/conversations/{conversation} Deprecated. Use representativeConversations instead.
trainingStats

object (Stats)

Output only. Statistics of the FAQ entry computed from training data.
botAnswers[]

object (BotAnswer)

Output only. Answers from the bot for the question.
insightsAnswers[]

object (InsightsAnswer)

Output only. Answers based on conversation history and live agent questions.
representativeConversations[]

object (RepresentativeConversation)

Output only. Examples of conversations representative of the FaqEntry

Stats

Training/inference statistics for the FAQ entry.

JSON representation 
{
  "conversationCount": integer,
  "averageHandlingTime": string,
  "trafficPercentage": number,
  "averageTurnCount": number
}
Fields
conversationCount

integer

Number of conversations asking the faq question.
averageHandlingTime

string (Duration format)

Average handling time for all conversations.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
trafficPercentage

number

Percentage of traffic in all conversations.
averageTurnCount

number

Average turn count.

BotAnswer

An answer from the bot for the question.

JSON representation 
{
  "answer": string,
  "matchingQuestion": string,
  "snippets": [
    {
      object (Snippet)
    }
  ]
}
Fields
answer

string

Answer text.
matchingQuestion

string

The matching question from the bot (e.g. from FAQ Assist).
snippets[]

object (Snippet)

All snippets used for this answer, with their source URI and data.

Snippet

Snippet Source for a bot answer.

JSON representation 
{
  "uri": string,
  "text": string,
  "title": string
}
Fields
uri

string

URI the data is sourced from.
text

string

Text taken from that URI.
title

string

Title of the document.

InsightsAnswer

An answer based on conversation history and live agent questions.

JSON representation 
{
  "answer": string
}
Fields
answer

string

Answer text.

RepresentativeConversation

Represents a point in a conversation that is representative of the parent FaqEntry

JSON representation 
{
  "name": string,
  "startTime": string
}
Fields
name

string

Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
startTime

string (Timestamp format)

The time at which the conversation started.

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".

Methods

delete

 Deletes an FAQ entry.

get

 Gets an FAQ entry.

list

 Lists FAQ entries.

patch

 Updates an FAQ entry.