com.google.cloud.aiplatform.v1

Interface GroundingMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GroundingMetadata, GroundingMetadata.Builder

@Generated
public interface GroundingMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getGoogleMapsWidgetContextToken() Optional.
com.google.protobuf.ByteString	getGoogleMapsWidgetContextTokenBytes() Optional.
GroundingChunk	getGroundingChunks(int index) List of supporting references retrieved from specified grounding source.
int	getGroundingChunksCount() List of supporting references retrieved from specified grounding source.
List<GroundingChunk>	getGroundingChunksList() List of supporting references retrieved from specified grounding source.
GroundingChunkOrBuilder	getGroundingChunksOrBuilder(int index) List of supporting references retrieved from specified grounding source.
List<? extends GroundingChunkOrBuilder>	getGroundingChunksOrBuilderList() List of supporting references retrieved from specified grounding source.
GroundingSupport	getGroundingSupports(int index) Optional.
int	getGroundingSupportsCount() Optional.
List<GroundingSupport>	getGroundingSupportsList() Optional.
GroundingSupportOrBuilder	getGroundingSupportsOrBuilder(int index) Optional.
List<? extends GroundingSupportOrBuilder>	getGroundingSupportsOrBuilderList() Optional.
RetrievalMetadata	getRetrievalMetadata() Optional.
RetrievalMetadataOrBuilder	getRetrievalMetadataOrBuilder() Optional.
SearchEntryPoint	getSearchEntryPoint() Optional.
SearchEntryPointOrBuilder	getSearchEntryPointOrBuilder() Optional.
GroundingMetadata.SourceFlaggingUri	getSourceFlaggingUris(int index) List of source flagging uris.
int	getSourceFlaggingUrisCount() List of source flagging uris.
List<GroundingMetadata.SourceFlaggingUri>	getSourceFlaggingUrisList() List of source flagging uris.
GroundingMetadata.SourceFlaggingUriOrBuilder	getSourceFlaggingUrisOrBuilder(int index) List of source flagging uris.
List<? extends GroundingMetadata.SourceFlaggingUriOrBuilder>	getSourceFlaggingUrisOrBuilderList() List of source flagging uris.
String	getWebSearchQueries(int index) Optional.
com.google.protobuf.ByteString	getWebSearchQueriesBytes(int index) Optional.
int	getWebSearchQueriesCount() Optional.
List<String>	getWebSearchQueriesList() Optional.
boolean	hasGoogleMapsWidgetContextToken() Optional.
boolean	hasRetrievalMetadata() Optional.
boolean	hasSearchEntryPoint() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getWebSearchQueriesList

List<String> getWebSearchQueriesList()

 Optional. Web search queries for the following-up web search.
 

repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the webSearchQueries.

getWebSearchQueriesCount

int getWebSearchQueriesCount()

 Optional. Web search queries for the following-up web search.
 

repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of webSearchQueries.

getWebSearchQueries

String getWebSearchQueries(int index)

 Optional. Web search queries for the following-up web search.
 

repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The webSearchQueries at the given index.

getWebSearchQueriesBytes

com.google.protobuf.ByteString getWebSearchQueriesBytes(int index)

 Optional. Web search queries for the following-up web search.
 

repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the webSearchQueries at the given index.

hasSearchEntryPoint

boolean hasSearchEntryPoint()

 Optional. Google search entry for the following-up web searches.
 

optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the searchEntryPoint field is set.

getSearchEntryPoint

SearchEntryPoint getSearchEntryPoint()

 Optional. Google search entry for the following-up web searches.
 

optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The searchEntryPoint.

getSearchEntryPointOrBuilder

SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()

 Optional. Google search entry for the following-up web searches.
 

optional .google.cloud.aiplatform.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

getGroundingChunksList

List<GroundingChunk> getGroundingChunksList()

 List of supporting references retrieved from specified grounding source.
 

repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;

getGroundingChunks

GroundingChunk getGroundingChunks(int index)

 List of supporting references retrieved from specified grounding source.
 

repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;

getGroundingChunksCount

int getGroundingChunksCount()

 List of supporting references retrieved from specified grounding source.
 

repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;

getGroundingChunksOrBuilderList

List<? extends GroundingChunkOrBuilder> getGroundingChunksOrBuilderList()

 List of supporting references retrieved from specified grounding source.
 

repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;

getGroundingChunksOrBuilder

GroundingChunkOrBuilder getGroundingChunksOrBuilder(int index)

 List of supporting references retrieved from specified grounding source.
 

repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;

getGroundingSupportsList

List<GroundingSupport> getGroundingSupportsList()

 Optional. List of grounding support.
 

repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

getGroundingSupports

GroundingSupport getGroundingSupports(int index)

 Optional. List of grounding support.
 

repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

getGroundingSupportsCount

int getGroundingSupportsCount()

 Optional. List of grounding support.
 

repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

getGroundingSupportsOrBuilderList

List<? extends GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()

 Optional. List of grounding support.
 

repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

getGroundingSupportsOrBuilder

GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)

 Optional. List of grounding support.
 

repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

hasRetrievalMetadata

boolean hasRetrievalMetadata()

 Optional. Output only. Retrieval metadata.
 

optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the retrievalMetadata field is set.

getRetrievalMetadata

RetrievalMetadata getRetrievalMetadata()

 Optional. Output only. Retrieval metadata.
 

optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The retrievalMetadata.

getRetrievalMetadataOrBuilder

RetrievalMetadataOrBuilder getRetrievalMetadataOrBuilder()

 Optional. Output only. Retrieval metadata.
 

optional .google.cloud.aiplatform.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

hasGoogleMapsWidgetContextToken

boolean hasGoogleMapsWidgetContextToken()

 Optional. Output only. Resource name of the Google Maps widget context
 token to be used with the PlacesContextElement widget to render contextual
 data. This is populated only for Google Maps grounding.
 

optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the googleMapsWidgetContextToken field is set.

getGoogleMapsWidgetContextToken

String getGoogleMapsWidgetContextToken()

 Optional. Output only. Resource name of the Google Maps widget context
 token to be used with the PlacesContextElement widget to render contextual
 data. This is populated only for Google Maps grounding.
 

optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The googleMapsWidgetContextToken.

getGoogleMapsWidgetContextTokenBytes

com.google.protobuf.ByteString getGoogleMapsWidgetContextTokenBytes()

 Optional. Output only. Resource name of the Google Maps widget context
 token to be used with the PlacesContextElement widget to render contextual
 data. This is populated only for Google Maps grounding.
 

optional string google_maps_widget_context_token = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for googleMapsWidgetContextToken.

getSourceFlaggingUrisList

List<GroundingMetadata.SourceFlaggingUri> getSourceFlaggingUrisList()

 List of source flagging uris. This is currently populated only for Google
 Maps grounding.
 

repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;

getSourceFlaggingUris

GroundingMetadata.SourceFlaggingUri getSourceFlaggingUris(int index)

 List of source flagging uris. This is currently populated only for Google
 Maps grounding.
 

repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;

getSourceFlaggingUrisCount

int getSourceFlaggingUrisCount()

 List of source flagging uris. This is currently populated only for Google
 Maps grounding.
 

repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;

getSourceFlaggingUrisOrBuilderList

List<? extends GroundingMetadata.SourceFlaggingUriOrBuilder> getSourceFlaggingUrisOrBuilderList()

 List of source flagging uris. This is currently populated only for Google
 Maps grounding.
 

repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;

getSourceFlaggingUrisOrBuilder

GroundingMetadata.SourceFlaggingUriOrBuilder getSourceFlaggingUrisOrBuilder(int index)

 List of source flagging uris. This is currently populated only for Google
 Maps grounding.
 

repeated .google.cloud.aiplatform.v1.GroundingMetadata.SourceFlaggingUri source_flagging_uris = 9;