SearchKnowledgeResponse

The response message for Conversations.SearchKnowledge.

JSON representation 
{
  "answers": [
    {
      object (SearchKnowledgeAnswer)
    }
  ],
  "rewrittenQuery": string,
  "searchKnowledgeDebugInfo": {
    object (SearchKnowledgeDebugInfo)
  }
}
Fields
answers[]

object (SearchKnowledgeAnswer)

Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence.
rewrittenQuery

string

The rewritten query used to search knowledge.
searchKnowledgeDebugInfo

object (SearchKnowledgeDebugInfo)

Debug info for SearchKnowledge.

SearchKnowledgeAnswer

Represents a SearchKnowledge answer.

JSON representation 
{
  "answer": string,
  "answerType": enum (AnswerType),
  "answerSources": [
    {
      object (AnswerSource)
    }
  ],
  "answerRecord": string
}
Fields
answer

string

The piece of text from the knowledge base documents that answers the search query
answerType

enum (AnswerType)

The type of the answer.
answerSources[]

object (AnswerSource)

All sources used to generate the answer.
answerRecord

string

The name of the answer record. Format: projects/<Project ID>/locations/<location ID>/answer Records/<Answer Record ID>

AnswerType

The type of the answer.

Enums
ANSWER_TYPE_UNSPECIFIED The answer has a unspecified type.
FAQ The answer is from FAQ documents.
GENERATIVE The answer is from generative model.
INTENT The answer is from intent matching.

AnswerSource

The sources of the answers.

JSON representation 
{
  "title": string,
  "uri": string,
  "snippet": string,
  "metadata": {
    object
  }
}
Fields
title

string

The title of the article.
uri

string

The URI of the article.
snippet

string

The relevant snippet of the article.
metadata

object (Struct format)

Metadata associated with the article.

SearchKnowledgeDebugInfo

Debug information related to SearchKnowledge feature.

JSON representation 
{
  "datastoreResponseReason": enum (DatastoreResponseReason),
  "searchKnowledgeBehavior": {
    object (SearchKnowledgeBehavior)
  },
  "ingestedContextReferenceDebugInfo": {
    object (IngestedContextReferenceDebugInfo)
  },
  "serviceLatency": {
    object (ServiceLatency)
  }
}
Fields
datastoreResponseReason

enum (DatastoreResponseReason)

Response reason from datastore which indicates data serving status or answer quality degradation.
searchKnowledgeBehavior

object (SearchKnowledgeBehavior)

Configured behaviors for SearchKnowledge.
ingestedContextReferenceDebugInfo

object (IngestedContextReferenceDebugInfo)

Information about parameters ingested for search knowledge.
serviceLatency

object (ServiceLatency)

The latency of the service.

SearchKnowledgeBehavior

Configured behaviors for SearchKnowledge.

JSON representation 
{
  "answerGenerationRewriterOn": boolean,
  "endUserMetadataIncluded": boolean,
  "thirdPartyConnectorAllowed": boolean
}
Fields
answerGenerationRewriterOn

boolean

Whether data store agent rewriter was turned on for the request.
endUserMetadataIncluded

boolean

Whether endUserMetadata is included in the data store agent call.
thirdPartyConnectorAllowed

boolean

This field indicates whether third party connectors are enabled for the project. Note that this field only indicates if the project is allowlisted for connectors.