REST Resource: projects.locations.collections.engines.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,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "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.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
completeTime

string (Timestamp format)

Output only. Answer completed timestamp.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
safetyRatings[]

object (SafetyRating)

Optional. Safety ratings.
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.