Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse (v0.17.0)

Version latest

• 0.17.0 (latest)
• 0.16.0
• 0.15.0
• 0.14.2
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse.

Response message for the GroundedGenerationService.CheckGrounding method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#cited_chunks

def cited_chunks() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>) — List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

#cited_chunks=

def cited_chunks=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>) — List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::FactChunk>) — List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

#cited_facts

def cited_facts() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::CheckGroundingFactChunk>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::CheckGroundingFactChunk>) — List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

#cited_facts=

def cited_facts=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::CheckGroundingFactChunk>

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::CheckGroundingFactChunk>) — List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::CheckGroundingFactChunk>) — List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

#claims

def claims() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>) — Claim texts and citation info across all claims in the answer candidate.

#claims=

def claims=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>) — Claim texts and citation info across all claims in the answer candidate.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim>) — Claim texts and citation info across all claims in the answer candidate.

#support_score

def support_score() -> ::Float

Returns

• (::Float) — The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

#support_score=

def support_score=(value) -> ::Float

Parameter

• value (::Float) — The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

Returns

• (::Float) — The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.