Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate (v1.4.0)

Version latest

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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::V1::GroundedGenerationContent

Returns

• (::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent) — Content of the candidate.

#content=

def content=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent) — Content of the candidate.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent) — Content of the candidate.

#grounding_metadata

def grounding_metadata() -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata

Returns

• (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata) — Grounding metadata for the generated content.

#grounding_metadata=

def grounding_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata) — Grounding metadata for the generated content.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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.