Class GroundingChunk.RetrievedContext (3.79.0)

Version latest

• 3.79.0 (latest)
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 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 GroundingChunk.RetrievedContext extends GeneratedMessageV3 implements GroundingChunk.RetrievedContextOrBuilder

Chunk from context retrieved by the retrieval tools.

Protobuf type google.cloud.aiplatform.v1beta1.GroundingChunk.RetrievedContext

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GroundingChunk.RetrievedContext

Implements

GroundingChunk.RetrievedContextOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DOCUMENT_NAME_FIELD_NUMBER

public static final int DOCUMENT_NAME_FIELD_NUMBER

Field Value
Type	Description
int

RAG_CHUNK_FIELD_NUMBER

public static final int RAG_CHUNK_FIELD_NUMBER

Field Value
Type	Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

Field Value
Type	Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

Field Value
Type	Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static GroundingChunk.RetrievedContext getDefaultInstance()

Returns
Type	Description
GroundingChunk.RetrievedContext

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static GroundingChunk.RetrievedContext.Builder newBuilder()

Returns
Type	Description
GroundingChunk.RetrievedContext.Builder

newBuilder(GroundingChunk.RetrievedContext prototype)

public static GroundingChunk.RetrievedContext.Builder newBuilder(GroundingChunk.RetrievedContext prototype)

Parameter
Name	Description
prototype	GroundingChunk.RetrievedContext

Returns
Type	Description
GroundingChunk.RetrievedContext.Builder

parseDelimitedFrom(InputStream input)

public static GroundingChunk.RetrievedContext parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingChunk.RetrievedContext parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static GroundingChunk.RetrievedContext parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GroundingChunk.RetrievedContext parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GroundingChunk.RetrievedContext parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GroundingChunk.RetrievedContext parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GroundingChunk.RetrievedContext parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingChunk.RetrievedContext parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static GroundingChunk.RetrievedContext parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingChunk.RetrievedContext parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static GroundingChunk.RetrievedContext parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GroundingChunk.RetrievedContext parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingChunk.RetrievedContext

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<GroundingChunk.RetrievedContext> parser()

Returns
Type	Description
Parser<RetrievedContext>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getContextDetailsCase()

public GroundingChunk.RetrievedContext.ContextDetailsCase getContextDetailsCase()

Returns
Type	Description
GroundingChunk.RetrievedContext.ContextDetailsCase

getDefaultInstanceForType()

public GroundingChunk.RetrievedContext getDefaultInstanceForType()

Returns
Type	Description
GroundingChunk.RetrievedContext

getDocumentName()

public String getDocumentName()

Output only. The full document name for the referenced Vertex AI Search document.

optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The documentName.

getDocumentNameBytes()

public ByteString getDocumentNameBytes()

Output only. The full document name for the referenced Vertex AI Search document.

optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for documentName.

getParserForType()

public Parser<GroundingChunk.RetrievedContext> getParserForType()

Returns
Type	Description
Parser<RetrievedContext>

Overrides

GeneratedMessageV3.getParserForType()

getRagChunk()

public RagChunk getRagChunk()

Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.

.google.cloud.aiplatform.v1beta1.RagChunk rag_chunk = 4;

Returns
Type	Description
RagChunk	The ragChunk.

getRagChunkOrBuilder()

public RagChunkOrBuilder getRagChunkOrBuilder()

Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.

.google.cloud.aiplatform.v1beta1.RagChunk rag_chunk = 4;

Returns
Type	Description
RagChunkOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getText()

public String getText()

Text of the attribution.

optional string text = 3;

Returns
Type	Description
String	The text.

getTextBytes()

public ByteString getTextBytes()

Text of the attribution.

optional string text = 3;

Returns
Type	Description
ByteString	The bytes for text.

getTitle()

public String getTitle()

Title of the attribution.

optional string title = 2;

Returns
Type	Description
String	The title.

getTitleBytes()

public ByteString getTitleBytes()

Title of the attribution.

optional string title = 2;

Returns
Type	Description
ByteString	The bytes for title.

getUri()

public String getUri()

URI reference of the attribution.

optional string uri = 1;

Returns
Type	Description
String	The uri.

getUriBytes()

public ByteString getUriBytes()

URI reference of the attribution.

optional string uri = 1;

Returns
Type	Description
ByteString	The bytes for uri.

hasDocumentName()

public boolean hasDocumentName()

Output only. The full document name for the referenced Vertex AI Search document.

optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the documentName field is set.

hasRagChunk()

public boolean hasRagChunk()

Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.

.google.cloud.aiplatform.v1beta1.RagChunk rag_chunk = 4;

Returns
Type	Description
boolean	Whether the ragChunk field is set.

hasText()

public boolean hasText()

Text of the attribution.

optional string text = 3;

Returns
Type	Description
boolean	Whether the text field is set.

hasTitle()

public boolean hasTitle()

Title of the attribution.

optional string title = 2;

Returns
Type	Description
boolean	Whether the title field is set.

hasUri()

public boolean hasUri()

URI reference of the attribution.

optional string uri = 1;

Returns
Type	Description
boolean	Whether the uri field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public GroundingChunk.RetrievedContext.Builder newBuilderForType()

Returns
Type	Description
GroundingChunk.RetrievedContext.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GroundingChunk.RetrievedContext.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
GroundingChunk.RetrievedContext.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public GroundingChunk.RetrievedContext.Builder toBuilder()

Returns
Type	Description
GroundingChunk.RetrievedContext.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException