- 3.73.0 (latest)
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface GroundingMetadataOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getGoogleMapsWidgetContextToken()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The googleMapsWidgetContextToken. |
getGoogleMapsWidgetContextTokenBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for googleMapsWidgetContextToken. |
getGroundingChunks(int index)
public abstract GroundingChunk getGroundingChunks(int index)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GroundingChunk |
|
getGroundingChunksCount()
public abstract int getGroundingChunksCount()List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getGroundingChunksList()
public abstract List<GroundingChunk> getGroundingChunksList()List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Returns | |
|---|---|
| Type | Description |
List<GroundingChunk> |
|
getGroundingChunksOrBuilder(int index)
public abstract GroundingChunkOrBuilder getGroundingChunksOrBuilder(int index)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GroundingChunkOrBuilder |
|
getGroundingChunksOrBuilderList()
public abstract List<? extends GroundingChunkOrBuilder> getGroundingChunksOrBuilderList()List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.GroundingChunkOrBuilder> |
|
getGroundingSupports(int index)
public abstract GroundingSupport getGroundingSupports(int index)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GroundingSupport |
|
getGroundingSupportsCount()
public abstract int getGroundingSupportsCount()Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getGroundingSupportsList()
public abstract List<GroundingSupport> getGroundingSupportsList()Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<GroundingSupport> |
|
getGroundingSupportsOrBuilder(int index)
public abstract GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GroundingSupportOrBuilder |
|
getGroundingSupportsOrBuilderList()
public abstract List<? extends GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.GroundingSupportOrBuilder> |
|
getRetrievalMetadata()
public abstract RetrievalMetadata getRetrievalMetadata()Optional. Output only. Retrieval metadata.
optional .google.cloud.aiplatform.v1beta1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
RetrievalMetadata |
The retrievalMetadata. |
getRetrievalMetadataOrBuilder()
public abstract RetrievalMetadataOrBuilder getRetrievalMetadataOrBuilder()Optional. Output only. Retrieval metadata.
optional .google.cloud.aiplatform.v1beta1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
RetrievalMetadataOrBuilder |
|
getRetrievalQueries(int index)
public abstract String getRetrievalQueries(int index)Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The retrievalQueries at the given index. |
getRetrievalQueriesBytes(int index)
public abstract ByteString getRetrievalQueriesBytes(int index)Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the retrievalQueries at the given index. |
getRetrievalQueriesCount()
public abstract int getRetrievalQueriesCount()Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of retrievalQueries. |
getRetrievalQueriesList()
public abstract List<String> getRetrievalQueriesList()Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the retrievalQueries. |
getSearchEntryPoint()
public abstract SearchEntryPoint getSearchEntryPoint()Optional. Google search entry for the following-up web searches.
optional .google.cloud.aiplatform.v1beta1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchEntryPoint |
The searchEntryPoint. |
getSearchEntryPointOrBuilder()
public abstract SearchEntryPointOrBuilder getSearchEntryPointOrBuilder()Optional. Google search entry for the following-up web searches.
optional .google.cloud.aiplatform.v1beta1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchEntryPointOrBuilder |
|
getWebSearchQueries(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The webSearchQueries at the given index. |
getWebSearchQueriesBytes(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the webSearchQueries at the given index. |
getWebSearchQueriesCount()
public abstract int getWebSearchQueriesCount()Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of webSearchQueries. |
getWebSearchQueriesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<String> |
A list containing the webSearchQueries. |
hasGoogleMapsWidgetContextToken()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the googleMapsWidgetContextToken field is set. |
hasRetrievalMetadata()
public abstract boolean hasRetrievalMetadata()Optional. Output only. Retrieval metadata.
optional .google.cloud.aiplatform.v1beta1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the retrievalMetadata field is set. |
hasSearchEntryPoint()
public abstract boolean hasSearchEntryPoint()Optional. Google search entry for the following-up web searches.
optional .google.cloud.aiplatform.v1beta1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchEntryPoint field is set. |