REST Resource: projects.locations.dataStores.sessions.answers

Resource: Answer

Defines an answer.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "groundingScore": number
}
Fields
name

string

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

The state of the answer generation.
answerText

string

The textual answer.
citations[]

object (Citation)

Citations.
groundingSupports[]

object (GroundingSupport)

Optional. Grounding supports.
references[]

object (Reference)

References.
relatedQuestions[]

string

Suggested related questions.
steps[]

object (Step)

Answer generation steps.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Query understanding information.
answerSkippedReasons[]

enum (AnswerSkippedReason)

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
createTime

string (Timestamp format)

Output only. Answer creation timestamp.

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

string (Timestamp format)

Output only. Answer completed timestamp.

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

number

A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.

Methods

get

 Gets a Answer.