Class RagChunk (3.64.0)

public final class RagChunk extends GeneratedMessageV3 implements RagChunkOrBuilder

A RagChunk includes the content of a chunk of a RagFile, and associated metadata.

Protobuf type google.cloud.aiplatform.v1.RagChunk

Implements

RagChunkOrBuilder

Static Fields

PAGE_SPAN_FIELD_NUMBER

public static final int PAGE_SPAN_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagChunk getDefaultInstance()
Returns
Type Description
RagChunk

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RagChunk.Builder newBuilder()
Returns
Type Description
RagChunk.Builder

newBuilder(RagChunk prototype)

public static RagChunk.Builder newBuilder(RagChunk prototype)
Parameter
Name Description
prototype RagChunk
Returns
Type Description
RagChunk.Builder

parseDelimitedFrom(InputStream input)

public static RagChunk parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagChunk
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagChunk parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagChunk
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RagChunk parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagChunk parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagChunk parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RagChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagChunk parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagChunk parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagChunk
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagChunk parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagChunk
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RagChunk parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagChunk
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagChunk parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagChunk
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RagChunk parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagChunk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagChunk parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagChunk
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RagChunk> parser()
Returns
Type Description
Parser<RagChunk>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RagChunk getDefaultInstanceForType()
Returns
Type Description
RagChunk

getPageSpan()

public RagChunk.PageSpan getPageSpan()

If populated, represents where the chunk starts and ends in the document.

optional .google.cloud.aiplatform.v1.RagChunk.PageSpan page_span = 2;

Returns
Type Description
RagChunk.PageSpan

The pageSpan.

getPageSpanOrBuilder()

public RagChunk.PageSpanOrBuilder getPageSpanOrBuilder()

If populated, represents where the chunk starts and ends in the document.

optional .google.cloud.aiplatform.v1.RagChunk.PageSpan page_span = 2;

Returns
Type Description
RagChunk.PageSpanOrBuilder

getParserForType()

public Parser<RagChunk> getParserForType()
Returns
Type Description
Parser<RagChunk>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getText()

public String getText()

The content of the chunk.

string text = 1;

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

The content of the chunk.

string text = 1;

Returns
Type Description
ByteString

The bytes for text.

hasPageSpan()

public boolean hasPageSpan()

If populated, represents where the chunk starts and ends in the document.

optional .google.cloud.aiplatform.v1.RagChunk.PageSpan page_span = 2;

Returns
Type Description
boolean

Whether the pageSpan field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RagChunk.Builder newBuilderForType()
Returns
Type Description
RagChunk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagChunk.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagChunk.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RagChunk.Builder toBuilder()
Returns
Type Description
RagChunk.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException