Resource: FaqEntry
The FAQ entry resource.
JSON representation |
---|
{ "name": string, "displayName": string, "question": string, "createTime": string, "updateTime": string, "representativeConversationNames": [ string ], "trainingStats": { object ( |
Fields | |
---|---|
name |
Immutable. The resource name of the FAQ entry. Format: projects/{project}/locations/{location}/faqModels/{faqModel}/faqEntries/{faqEntry} |
displayName |
Representative name of the FAQ entry, typically the question text. |
question |
Output only. Question of the FAQ. |
createTime |
Output only. FAQ entry creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. FAQ entry last update time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
representativeConversationNames[] |
Output only. Resource names of the most representative conversations matched. Format: projects/{project}/locations/{location}/conversations/{conversation} Deprecated. Use |
trainingStats |
Output only. Statistics of the FAQ entry computed from training data. |
botAnswers[] |
Output only. Answers from the bot for the question. |
insightsAnswers[] |
Output only. Answers based on conversation history and live agent questions. |
representativeConversations[] |
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 |
Number of conversations asking the faq question. |
averageHandlingTime |
Average handling time for all conversations. A duration in seconds with up to nine fractional digits, ending with ' |
trafficPercentage |
Percentage of traffic in all conversations. |
averageTurnCount |
Average turn count. |
BotAnswer
An answer from the bot for the question.
JSON representation |
---|
{
"answer": string,
"matchingQuestion": string,
"snippets": [
{
object ( |
Fields | |
---|---|
answer |
Answer text. |
matchingQuestion |
The matching question from the bot (e.g. from FAQ Assist). |
snippets[] |
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 |
URI the data is sourced from. |
text |
Text taken from that URI. |
title |
Title of the document. |
InsightsAnswer
An answer based on conversation history and live agent questions.
JSON representation |
---|
{ "answer": string } |
Fields | |
---|---|
answer |
Answer text. |
RepresentativeConversation
Represents a point in a conversation that is representative of the parent FaqEntry
JSON representation |
---|
{ "name": string, "startTime": string } |
Fields | |
---|---|
name |
Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} |
startTime |
The time at which the conversation started. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Methods |
|
---|---|
|
Deletes an FAQ entry. |
|
Gets an FAQ entry. |
|
Lists FAQ entries. |
|
Updates an FAQ entry. |