public final class GroundingMetadata extends GeneratedMessageV3 implements GroundingMetadataOrBuilder
Metadata returned to client when grounding is enabled.
Protobuf type google.cloud.aiplatform.v1.GroundingMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int GROUNDING_CHUNKS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GROUNDING_SUPPORTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RETRIEVAL_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SEARCH_ENTRY_POINT_FIELD_NUMBER
public static final int SEARCH_ENTRY_POINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int WEB_SEARCH_QUERIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static GroundingMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static GroundingMetadata.Builder newBuilder()
public static GroundingMetadata.Builder newBuilder(GroundingMetadata prototype)
public static GroundingMetadata parseDelimitedFrom(InputStream input)
public static GroundingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GroundingMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static GroundingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GroundingMetadata parseFrom(ByteString data)
public static GroundingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GroundingMetadata parseFrom(CodedInputStream input)
public static GroundingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GroundingMetadata parseFrom(InputStream input)
public static GroundingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GroundingMetadata parseFrom(ByteBuffer data)
public static GroundingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<GroundingMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public GroundingMetadata getDefaultInstanceForType()
public GroundingChunk getGroundingChunks(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
| Parameter |
| Name |
Description |
index |
int
|
public int getGroundingChunksCount()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
| Returns |
| Type |
Description |
int |
|
public List<GroundingChunk> getGroundingChunksList()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
public GroundingChunkOrBuilder getGroundingChunksOrBuilder(int index)
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends GroundingChunkOrBuilder> getGroundingChunksOrBuilderList()
List of supporting references retrieved from specified grounding source.
repeated .google.cloud.aiplatform.v1.GroundingChunk grounding_chunks = 5;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1.GroundingChunkOrBuilder> |
|
public GroundingSupport getGroundingSupports(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public int getGroundingSupportsCount()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public List<GroundingSupport> getGroundingSupportsList()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
public GroundingSupportOrBuilder getGroundingSupportsOrBuilder(int index)
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends GroundingSupportOrBuilder> getGroundingSupportsOrBuilderList()
Optional. List of grounding support.
repeated .google.cloud.aiplatform.v1.GroundingSupport grounding_supports = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1.GroundingSupportOrBuilder> |
|
public Parser<GroundingMetadata> getParserForType()
Overrides
public 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];
public 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];
getSearchEntryPoint()
public 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];
getSearchEntryPointOrBuilder()
public 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];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The webSearchQueries at the given 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 |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the webSearchQueries at the given index.
|
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.
|
public ProtocolStringList getWebSearchQueriesList()
Optional. Web search queries for the following-up web search.
repeated string web_search_queries = 1 [(.google.api.field_behavior) = OPTIONAL];
public 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 |
| 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.v1.SearchEntryPoint search_entry_point = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the searchEntryPoint field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public GroundingMetadata.Builder newBuilderForType()
protected GroundingMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public GroundingMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
