View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1Answer (google_api_discovery_engine v0.27.0)

Defines an answer.

Attributes

  • answerSkippedReasons (type: list(String.t), default: nil) - Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
  • answerText (type: String.t, default: nil) - The textual answer.
  • citations (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerCitation.t), default: nil) - Citations.
  • completeTime (type: DateTime.t, default: nil) - Output only. Answer completed timestamp.
  • createTime (type: DateTime.t, default: nil) - Output only. Answer creation timestamp.
  • groundingScore (type: float(), default: nil) - A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.
  • groundingSupports (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerGroundingSupport.t), default: nil) - Optional. Grounding supports.
  • name (type: String.t, default: nil) - Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
  • queryUnderstandingInfo (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo.t, default: nil) - Query understanding information.
  • references (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerReference.t), default: nil) - References.
  • relatedQuestions (type: list(String.t), default: nil) - Suggested related questions.
  • state (type: String.t, default: nil) - The state of the answer generation.
  • steps (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerStep.t), default: nil) - Answer generation steps.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1Answer{
  answerSkippedReasons: [String.t()] | nil,
  answerText: String.t() | nil,
  citations:
    [
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerCitation.t()
    ]
    | nil,
  completeTime: DateTime.t() | nil,
  createTime: DateTime.t() | nil,
  groundingScore: float() | nil,
  groundingSupports:
    [
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerGroundingSupport.t()
    ]
    | nil,
  name: String.t() | nil,
  queryUnderstandingInfo:
    GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo.t()
    | nil,
  references:
    [
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerReference.t()
    ]
    | nil,
  relatedQuestions: [String.t()] | nil,
  state: String.t() | nil,
  steps:
    [
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1AnswerStep.t()
    ]
    | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.