Interface GroundingMetadataOrBuilder (1.36.0)

Version latest

• 1.36.0 (latest)
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface GroundingMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGroundingChunks(int index)

public abstract GroundingChunk getGroundingChunks(int index)

List of supporting references retrieved from specified grounding source.

repeated .google.cloud.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.GroundingChunk grounding_chunks = 5;

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.GroundingChunkOrBuilder>

getGroundingSupports(int index)

public abstract GroundingSupport getGroundingSupports(int index)

Optional. List of grounding support.

repeated .google.cloud.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.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.vertexai.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.vertexai.api.GroundingSupportOrBuilder>

getRetrievalMetadata()

public abstract RetrievalMetadata getRetrievalMetadata()

Optional. Output only. Retrieval metadata.

optional .google.cloud.vertexai.v1.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.vertexai.v1.RetrievalMetadata retrieval_metadata = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
RetrievalMetadataOrBuilder

getSearchEntryPoint()

public abstract SearchEntryPoint getSearchEntryPoint()

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

optional .google.cloud.vertexai.v1.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.vertexai.v1.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	int The 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	int The 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.

hasRetrievalMetadata()

public abstract boolean hasRetrievalMetadata()

Optional. Output only. Retrieval metadata.

optional .google.cloud.vertexai.v1.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.vertexai.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the searchEntryPoint field is set.