Class Citations.InlineCitation (0.19.0)

public static final class Citations.InlineCitation extends GeneratedMessage implements Citations.InlineCitationOrBuilder

An inline citation in the response text.

Protobuf type google.cloud.ces.v1beta.Citations.InlineCitation

Static Fields

CITED_CHUNK_INDICES_FIELD_NUMBER

public static final int CITED_CHUNK_INDICES_FIELD_NUMBER
Field Value
Type Description
int

END_INDEX_FIELD_NUMBER

public static final int END_INDEX_FIELD_NUMBER
Field Value
Type Description
int

START_INDEX_FIELD_NUMBER

public static final int START_INDEX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Citations.InlineCitation getDefaultInstance()
Returns
Type Description
Citations.InlineCitation

getDescriptor()

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

newBuilder()

public static Citations.InlineCitation.Builder newBuilder()
Returns
Type Description
Citations.InlineCitation.Builder

newBuilder(Citations.InlineCitation prototype)

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

parseDelimitedFrom(InputStream input)

public static Citations.InlineCitation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Citations.InlineCitation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Citations.InlineCitation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Citations.InlineCitation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Citations.InlineCitation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Citations.InlineCitation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Citations.InlineCitation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Citations.InlineCitation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Citations.InlineCitation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Citations.InlineCitation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Citations.InlineCitation> parser()
Returns
Type Description
Parser<InlineCitation>

Methods

equals(Object obj)

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

getCitedChunkIndices(int index)

public int getCitedChunkIndices(int index)

The indices of the cited chunks that back this text segment. Indices refer to the elements in cited_chunks.

repeated int32 cited_chunk_indices = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The citedChunkIndices at the given index.

getCitedChunkIndicesCount()

public int getCitedChunkIndicesCount()

The indices of the cited chunks that back this text segment. Indices refer to the elements in cited_chunks.

repeated int32 cited_chunk_indices = 3;

Returns
Type Description
int

The count of citedChunkIndices.

getCitedChunkIndicesList()

public List<Integer> getCitedChunkIndicesList()

The indices of the cited chunks that back this text segment. Indices refer to the elements in cited_chunks.

repeated int32 cited_chunk_indices = 3;

Returns
Type Description
List<Integer>

A list containing the citedChunkIndices.

getDefaultInstanceForType()

public Citations.InlineCitation getDefaultInstanceForType()
Returns
Type Description
Citations.InlineCitation

getEndIndex()

public int getEndIndex()

The ending index (in bytes) of the text segment in the agent response.

int32 end_index = 2;

Returns
Type Description
int

The endIndex.

getParserForType()

public Parser<Citations.InlineCitation> getParserForType()
Returns
Type Description
Parser<InlineCitation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartIndex()

public int getStartIndex()

The starting index (in bytes) of the text segment in the agent response.

int32 start_index = 1;

Returns
Type Description
int

The startIndex.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Citations.InlineCitation.Builder newBuilderForType()
Returns
Type Description
Citations.InlineCitation.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Citations.InlineCitation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Citations.InlineCitation.Builder
Overrides

toBuilder()

public Citations.InlineCitation.Builder toBuilder()
Returns
Type Description
Citations.InlineCitation.Builder

writeTo(CodedOutputStream output)

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