Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate.
A response candidate generated from the model.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#content
def content() -> ::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent) — Content of the candidate.
#content=
def content=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent) — Content of the candidate.
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationContent) — Content of the candidate.
#grounding_metadata
def grounding_metadata() -> ::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata) — Grounding metadata for the generated content.
#grounding_metadata=
def grounding_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata) — Grounding metadata for the generated content.
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse::Candidate::GroundingMetadata) — Grounding metadata for the generated content.
#grounding_score
def grounding_score() -> ::Float
Returns
- (::Float) — The overall grounding score for the candidate, in the range of [0, 1].
#grounding_score=
def grounding_score=(value) -> ::Float
Parameter
- value (::Float) — The overall grounding score for the candidate, in the range of [0, 1].
Returns
- (::Float) — The overall grounding score for the candidate, in the range of [0, 1].
#index
def index() -> ::Integer
Returns
- (::Integer) — Index of the candidate.
#index=
def index=(value) -> ::Integer
Parameter
- value (::Integer) — Index of the candidate.
Returns
- (::Integer) — Index of the candidate.