- 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 static final class GroundingMetadata.Builder extends GeneratedMessageV3.Builder<GroundingMetadata.Builder> implements GroundingMetadataOrBuilderMetadata returned to client when grounding is enabled.
Protobuf type google.cloud.aiplatform.v1beta1.GroundingMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GroundingMetadata.BuilderImplements
GroundingMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllGroundingChunks(Iterable<? extends GroundingChunk> values)
public GroundingMetadata.Builder addAllGroundingChunks(Iterable<? extends GroundingChunk> values)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1beta1.GroundingChunk> |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addAllGroundingSupports(Iterable<? extends GroundingSupport> values)
public GroundingMetadata.Builder addAllGroundingSupports(Iterable<? extends GroundingSupport> values)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1beta1.GroundingSupport> |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addAllRetrievalQueries(Iterable<String> values)
public GroundingMetadata.Builder addAllRetrievalQueries(Iterable<String> values)Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The retrievalQueries to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
addAllWebSearchQueries(Iterable<String> values)
public GroundingMetadata.Builder addAllWebSearchQueries(Iterable<String> values)Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The webSearchQueries to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
addGroundingChunks(GroundingChunk value)
public GroundingMetadata.Builder addGroundingChunks(GroundingChunk value)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
GroundingChunk |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingChunks(GroundingChunk.Builder builderForValue)
public GroundingMetadata.Builder addGroundingChunks(GroundingChunk.Builder builderForValue)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GroundingChunk.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingChunks(int index, GroundingChunk value)
public GroundingMetadata.Builder addGroundingChunks(int index, GroundingChunk value)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GroundingChunk |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingChunks(int index, GroundingChunk.Builder builderForValue)
public GroundingMetadata.Builder addGroundingChunks(int index, GroundingChunk.Builder builderForValue)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GroundingChunk.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingChunksBuilder()
public GroundingChunk.Builder addGroundingChunksBuilder()List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Returns | |
|---|---|
| Type | Description |
GroundingChunk.Builder |
|
addGroundingChunksBuilder(int index)
public GroundingChunk.Builder addGroundingChunksBuilder(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.Builder |
|
addGroundingSupports(GroundingSupport value)
public GroundingMetadata.Builder addGroundingSupports(GroundingSupport value)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingSupports(GroundingSupport.Builder builderForValue)
public GroundingMetadata.Builder addGroundingSupports(GroundingSupport.Builder builderForValue)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GroundingSupport.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingSupports(int index, GroundingSupport value)
public GroundingMetadata.Builder addGroundingSupports(int index, GroundingSupport value)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingSupports(int index, GroundingSupport.Builder builderForValue)
public GroundingMetadata.Builder addGroundingSupports(int index, GroundingSupport.Builder builderForValue)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GroundingSupport.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addGroundingSupportsBuilder()
public GroundingSupport.Builder addGroundingSupportsBuilder()Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GroundingSupport.Builder |
|
addGroundingSupportsBuilder(int index)
public GroundingSupport.Builder addGroundingSupportsBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GroundingMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
addRetrievalQueries(String value)
public GroundingMetadata.Builder addRetrievalQueries(String value)Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe retrievalQueries to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
addRetrievalQueriesBytes(ByteString value)
public GroundingMetadata.Builder addRetrievalQueriesBytes(ByteString value)Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the retrievalQueries to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
addWebSearchQueries(String value)
public GroundingMetadata.Builder addWebSearchQueries(String value)Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe webSearchQueries to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
addWebSearchQueriesBytes(ByteString value)
public GroundingMetadata.Builder addWebSearchQueriesBytes(ByteString value)Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the webSearchQueries to add. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
build()
public GroundingMetadata build()| Returns | |
|---|---|
| Type | Description |
GroundingMetadata |
|
buildPartial()
public GroundingMetadata buildPartial()| Returns | |
|---|---|
| Type | Description |
GroundingMetadata |
|
clear()
public GroundingMetadata.Builder clear()| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public GroundingMetadata.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
clearGoogleMapsWidgetContextToken()
public GroundingMetadata.Builder clearGoogleMapsWidgetContextToken()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 |
GroundingMetadata.Builder |
This builder for chaining. |
clearGroundingChunks()
public GroundingMetadata.Builder clearGroundingChunks()List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
clearGroundingSupports()
public GroundingMetadata.Builder clearGroundingSupports()Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public GroundingMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
clearRetrievalMetadata()
public GroundingMetadata.Builder clearRetrievalMetadata()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 |
GroundingMetadata.Builder |
|
clearRetrievalQueries()
public GroundingMetadata.Builder clearRetrievalQueries()Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
clearSearchEntryPoint()
public GroundingMetadata.Builder clearSearchEntryPoint()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 |
GroundingMetadata.Builder |
|
clearWebSearchQueries()
public GroundingMetadata.Builder clearWebSearchQueries()Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
clone()
public GroundingMetadata.Builder clone()| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
getDefaultInstanceForType()
public GroundingMetadata getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GroundingMetadata |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getGoogleMapsWidgetContextToken()
public 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 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 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 |
|
getGroundingChunksBuilder(int index)
public GroundingChunk.Builder getGroundingChunksBuilder(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.Builder |
|
getGroundingChunksBuilderList()
public List<GroundingChunk.Builder> getGroundingChunksBuilderList()List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getGroundingChunksCount()
public 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 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 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 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 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 |
|
getGroundingSupportsBuilder(int index)
public GroundingSupport.Builder getGroundingSupportsBuilder(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.Builder |
|
getGroundingSupportsBuilderList()
public List<GroundingSupport.Builder> getGroundingSupportsBuilderList()Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getGroundingSupportsCount()
public 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 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 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 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 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. |
getRetrievalMetadataBuilder()
public RetrievalMetadata.Builder getRetrievalMetadataBuilder()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.Builder |
|
getRetrievalMetadataOrBuilder()
public 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 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 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 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 ProtocolStringList getRetrievalQueriesList()Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the retrievalQueries. |
getSearchEntryPoint()
public 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. |
getSearchEntryPointBuilder()
public SearchEntryPoint.Builder getSearchEntryPointBuilder()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.Builder |
|
getSearchEntryPointOrBuilder()
public 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the webSearchQueries. |
hasGoogleMapsWidgetContextToken()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GroundingMetadata other)
public GroundingMetadata.Builder mergeFrom(GroundingMetadata other)| Parameter | |
|---|---|
| Name | Description |
other |
GroundingMetadata |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GroundingMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GroundingMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
mergeRetrievalMetadata(RetrievalMetadata value)
public GroundingMetadata.Builder mergeRetrievalMetadata(RetrievalMetadata value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RetrievalMetadata |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
mergeSearchEntryPoint(SearchEntryPoint value)
public GroundingMetadata.Builder mergeSearchEntryPoint(SearchEntryPoint value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchEntryPoint |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GroundingMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
removeGroundingChunks(int index)
public GroundingMetadata.Builder removeGroundingChunks(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 |
GroundingMetadata.Builder |
|
removeGroundingSupports(int index)
public GroundingMetadata.Builder removeGroundingSupports(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 |
GroundingMetadata.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public GroundingMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setGoogleMapsWidgetContextToken(String value)
public GroundingMetadata.Builder setGoogleMapsWidgetContextToken(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe googleMapsWidgetContextToken to set. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
setGoogleMapsWidgetContextTokenBytes(ByteString value)
public GroundingMetadata.Builder setGoogleMapsWidgetContextTokenBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for googleMapsWidgetContextToken to set. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
setGroundingChunks(int index, GroundingChunk value)
public GroundingMetadata.Builder setGroundingChunks(int index, GroundingChunk value)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GroundingChunk |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setGroundingChunks(int index, GroundingChunk.Builder builderForValue)
public GroundingMetadata.Builder setGroundingChunks(int index, GroundingChunk.Builder builderForValue)List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1beta1.GroundingChunk grounding_chunks = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GroundingChunk.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setGroundingSupports(int index, GroundingSupport value)
public GroundingMetadata.Builder setGroundingSupports(int index, GroundingSupport value)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GroundingSupport |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setGroundingSupports(int index, GroundingSupport.Builder builderForValue)
public GroundingMetadata.Builder setGroundingSupports(int index, GroundingSupport.Builder builderForValue)Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1beta1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GroundingSupport.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GroundingMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setRetrievalMetadata(RetrievalMetadata value)
public GroundingMetadata.Builder setRetrievalMetadata(RetrievalMetadata value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
RetrievalMetadata |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setRetrievalMetadata(RetrievalMetadata.Builder builderForValue)
public GroundingMetadata.Builder setRetrievalMetadata(RetrievalMetadata.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RetrievalMetadata.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setRetrievalQueries(int index, String value)
public GroundingMetadata.Builder setRetrievalQueries(int index, String value)Optional. Queries executed by the retrieval tools.
repeated string retrieval_queries = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe retrievalQueries to set. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |
setSearchEntryPoint(SearchEntryPoint value)
public GroundingMetadata.Builder setSearchEntryPoint(SearchEntryPoint value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchEntryPoint |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setSearchEntryPoint(SearchEntryPoint.Builder builderForValue)
public GroundingMetadata.Builder setSearchEntryPoint(SearchEntryPoint.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchEntryPoint.Builder |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final GroundingMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
|
setWebSearchQueries(int index, String value)
public GroundingMetadata.Builder setWebSearchQueries(int index, String value)Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe webSearchQueries to set. |
| Returns | |
|---|---|
| Type | Description |
GroundingMetadata.Builder |
This builder for chaining. |