Package com.oracle.bmc.generativeaiinference.model

Class GroundingMetadata

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.GroundingMetadata

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class GroundingMetadata
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Grounding metadata.
Note: Objects should always be created or deserialized using the GroundingMetadata.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the GroundingMetadata.Builder, which maintain a set of all explicitly set fields called GroundingMetadata.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroundingMetadata.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
GroundingMetadata(List<String> webSearchQueries, SearchEntryPoint searchEntryPoint, List<GroundingChunk> groundingChunks, List<GroundingSupport> groundingSupports)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static GroundingMetadata.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<GroundingChunk>	getGroundingChunks()	Array of objects containing the web sources.
List<GroundingSupport>	getGroundingSupports()	Array of chunks to connect model response text to the sources in groundingChunks.
SearchEntryPoint	getSearchEntryPoint()
List<String>	getWebSearchQueries()	The queries to be used for Search suggestions.
int	hashCode()
GroundingMetadata.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

GroundingMetadata

@Deprecated
@ConstructorProperties({"webSearchQueries","searchEntryPoint","groundingChunks","groundingSupports"})
public GroundingMetadata(List<String> webSearchQueries,
                         SearchEntryPoint searchEntryPoint,
                         List<GroundingChunk> groundingChunks,
                         List<GroundingSupport> groundingSupports)

Deprecated.

Method Detail

builder

public static GroundingMetadata.Builder builder()

Create a new builder.

toBuilder

public GroundingMetadata.Builder toBuilder()

getWebSearchQueries

public List<String> getWebSearchQueries()

The queries to be used for Search suggestions.

Returns:

the value

getSearchEntryPoint

public SearchEntryPoint getSearchEntryPoint()

getGroundingChunks

public List<GroundingChunk> getGroundingChunks()

Array of objects containing the web sources.

Returns:

the value

getGroundingSupports

public List<GroundingSupport> getGroundingSupports()

Array of chunks to connect model response text to the sources in groundingChunks.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel