KnowledgeAnswers

Represents the result of querying a Knowledge base.

JSON representation
{
  "answers": [
    {
      object(Answer)
    }
  ]
}
Fields
answers[]

object(Answer)

A list of answers from Knowledge Connector.

Answer

An answer from Knowledge Connector.

JSON representation
{
  "source": string,
  "faqQuestion": string,
  "answer": string,
  "matchConfidenceLevel": enum(MatchConfidenceLevel),
  "matchConfidence": number
}
Fields
source

string

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

faqQuestion

string

The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.

answer

string

The piece of text from the source knowledge base document that answers this conversational query.

matchConfidenceLevel

enum(MatchConfidenceLevel)

The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given <query, answer> pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.

matchConfidence

number

The system's confidence score that this Knowledge answer is a good match for this converstational query, range from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement, we may deprecate it in the future. We recommend using matchConfidenceLevel which should be generally more stable.