Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Answer::GroundingSupport (v2.1.1)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Answer::GroundingSupport.

Grounding support for a claim in answer_text.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#end_index

def end_index() -> ::Integer
Returns
  • (::Integer) — Required. End of the claim, exclusive.

#end_index=

def end_index=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. End of the claim, exclusive.
Returns
  • (::Integer) — Required. End of the claim, exclusive.

#grounding_check_required

def grounding_check_required() -> ::Boolean
Returns
  • (::Boolean) — 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.

#grounding_check_required=

def grounding_check_required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#grounding_score

def grounding_score() -> ::Float
Returns
  • (::Float) — 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.

#grounding_score=

def grounding_score=(value) -> ::Float
Parameter
  • value (::Float) — 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.
Returns
  • (::Float) — 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

def sources() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::CitationSource>
Returns

#sources=

def sources=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::CitationSource>
Parameter
Returns

#start_index

def start_index() -> ::Integer
Returns
  • (::Integer) — Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).

#start_index=

def start_index=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).
Returns
  • (::Integer) — Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).