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

Grounding support for a claim in answer_text.

Attributes

  • endIndex (type: String.t, default: nil) - Required. End of the claim, exclusive.
  • groundingCheckRequired (type: boolean(), default: nil) - Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore grounding_score, sources is not returned.
  • groundingScore (type: float(), default: nil) - A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.
  • sources (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaAnswerCitationSource.t), default: nil) - Optional. Citation sources for the claim.
  • startIndex (type: String.t, default: nil) - Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport{
    endIndex: String.t() | nil,
    groundingCheckRequired: boolean() | nil,
    groundingScore: float() | nil,
    sources:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaAnswerCitationSource.t()
      ]
      | nil,
    startIndex: String.t() | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.