Interface GenerateGroundedContentResponse.CandidateOrBuilder (0.51.0)

public static interface GenerateGroundedContentResponse.CandidateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContent()

public abstract GroundedGenerationContent getContent()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type Description
GroundedGenerationContent

The content.

getContentOrBuilder()

public abstract GroundedGenerationContentOrBuilder getContentOrBuilder()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type Description
GroundedGenerationContentOrBuilder

getGroundingMetadata()

public abstract GenerateGroundedContentResponse.Candidate.GroundingMetadata getGroundingMetadata()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadata

The groundingMetadata.

getGroundingMetadataOrBuilder()

public abstract GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type Description
GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder

getGroundingScore()

public abstract float getGroundingScore()

The overall grounding score for the candidate, in the range of [0, 1].

optional float grounding_score = 3;

Returns
Type Description
float

The groundingScore.

getIndex()

public abstract int getIndex()

Index of the candidate.

int32 index = 1;

Returns
Type Description
int

The index.

hasContent()

public abstract boolean hasContent()

Content of the candidate.

.google.cloud.discoveryengine.v1.GroundedGenerationContent content = 2;

Returns
Type Description
boolean

Whether the content field is set.

hasGroundingMetadata()

public abstract boolean hasGroundingMetadata()

Grounding metadata for the generated content.

.google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;

Returns
Type Description
boolean

Whether the groundingMetadata field is set.

hasGroundingScore()

public abstract boolean hasGroundingScore()

The overall grounding score for the candidate, in the range of [0, 1].

optional float grounding_score = 3;

Returns
Type Description
boolean

Whether the groundingScore field is set.