Record Class GroundingMetadata

java.lang.Object

java.lang.Record

dev.langchain4j.model.googleai.GroundingMetadata

public record GroundingMetadata(List<GroundingMetadata.GroundingChunk> groundingChunks, List<GroundingMetadata.GroundingSupport> groundingSupports, List<String> webSearchQueries, GroundingMetadata.SearchEntryPoint searchEntryPoint, GroundingMetadata.RetrievalMetadata retrievalMetadata, String googleMapsWidgetContextToken)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroundingMetadata.Builder
static final record	GroundingMetadata.GroundingChunk
static final record	GroundingMetadata.GroundingSupport
static final record	GroundingMetadata.RetrievalMetadata
static final record	GroundingMetadata.SearchEntryPoint
static final record	GroundingMetadata.Segment

Constructor Summary

Constructors

Constructor	Description
GroundingMetadata(List<GroundingMetadata.GroundingChunk> groundingChunks, List<GroundingMetadata.GroundingSupport> groundingSupports, List<String> webSearchQueries, GroundingMetadata.SearchEntryPoint searchEntryPoint, GroundingMetadata.RetrievalMetadata retrievalMetadata, String googleMapsWidgetContextToken)	Creates an instance of a GroundingMetadata record class.

Method Summary

Modifier and Type	Method	Description
static GroundingMetadata.Builder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	googleMapsWidgetContextToken()	Returns the value of the googleMapsWidgetContextToken record component.
List<GroundingMetadata.GroundingChunk>	groundingChunks()	Returns the value of the groundingChunks record component.
List<GroundingMetadata.GroundingSupport>	groundingSupports()	Returns the value of the groundingSupports record component.
final int	hashCode()	Returns a hash code value for this object.
GroundingMetadata.RetrievalMetadata	retrievalMetadata()	Returns the value of the retrievalMetadata record component.
GroundingMetadata.SearchEntryPoint	searchEntryPoint()	Returns the value of the searchEntryPoint record component.
final String	toString()	Returns a string representation of this record class.
List<String>	webSearchQueries()	Returns the value of the webSearchQueries record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GroundingMetadata

public GroundingMetadata(List<GroundingMetadata.GroundingChunk> groundingChunks,
 List<GroundingMetadata.GroundingSupport> groundingSupports,
 List<String> webSearchQueries,
 GroundingMetadata.SearchEntryPoint searchEntryPoint,
 GroundingMetadata.RetrievalMetadata retrievalMetadata,
 String googleMapsWidgetContextToken)

Creates an instance of a GroundingMetadata record class.

Parameters:

groundingChunks - the value for the groundingChunks record component

groundingSupports - the value for the groundingSupports record component

webSearchQueries - the value for the webSearchQueries record component

searchEntryPoint - the value for the searchEntryPoint record component

retrievalMetadata - the value for the retrievalMetadata record component

googleMapsWidgetContextToken - the value for the googleMapsWidgetContextToken record component

Method Details

builder

public static GroundingMetadata.Builder builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

groundingChunks

public List<GroundingMetadata.GroundingChunk> groundingChunks()

Returns the value of the groundingChunks record component.

Returns:

the value of the groundingChunks record component

groundingSupports

public List<GroundingMetadata.GroundingSupport> groundingSupports()

Returns the value of the groundingSupports record component.

Returns:

the value of the groundingSupports record component

webSearchQueries

public List<String> webSearchQueries()

Returns the value of the webSearchQueries record component.

Returns:

the value of the webSearchQueries record component

searchEntryPoint

public GroundingMetadata.SearchEntryPoint searchEntryPoint()

Returns the value of the searchEntryPoint record component.

Returns:

the value of the searchEntryPoint record component

retrievalMetadata

public GroundingMetadata.RetrievalMetadata retrievalMetadata()

Returns the value of the retrievalMetadata record component.

Returns:

the value of the retrievalMetadata record component

googleMapsWidgetContextToken

public String googleMapsWidgetContextToken()

Returns the value of the googleMapsWidgetContextToken record component.

Returns:

the value of the googleMapsWidgetContextToken record component