Class RagContextRecallInstance (3.40.0)

public final class RagContextRecallInstance extends GeneratedMessageV3 implements RagContextRecallInstanceOrBuilder

Spec for rag context recall instance.

Protobuf type google.cloud.aiplatform.v1beta1.RagContextRecallInstance

Static Fields

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER
Field Value
TypeDescription
int

REFERENCE_FIELD_NUMBER

public static final int REFERENCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RagContextRecallInstance getDefaultInstance()
Returns
TypeDescription
RagContextRecallInstance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RagContextRecallInstance.Builder newBuilder()
Returns
TypeDescription
RagContextRecallInstance.Builder

newBuilder(RagContextRecallInstance prototype)

public static RagContextRecallInstance.Builder newBuilder(RagContextRecallInstance prototype)
Parameter
NameDescription
prototypeRagContextRecallInstance
Returns
TypeDescription
RagContextRecallInstance.Builder

parseDelimitedFrom(InputStream input)

public static RagContextRecallInstance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RagContextRecallInstance parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagContextRecallInstance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagContextRecallInstance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RagContextRecallInstance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RagContextRecallInstance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagContextRecallInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RagContextRecallInstance
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RagContextRecallInstance> parser()
Returns
TypeDescription
Parser<RagContextRecallInstance>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getContext()

public String getContext()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The context.

getContextBytes()

public ByteString getContextBytes()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for context.

getDefaultInstanceForType()

public RagContextRecallInstance getDefaultInstanceForType()
Returns
TypeDescription
RagContextRecallInstance

getParserForType()

public Parser<RagContextRecallInstance> getParserForType()
Returns
TypeDescription
Parser<RagContextRecallInstance>
Overrides

getReference()

public String getReference()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The reference.

getReferenceBytes()

public ByteString getReferenceBytes()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for reference.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasContext()

public boolean hasContext()

Required. Retrieved facts from RAG pipeline as context to be evaluated.

optional string context = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the context field is set.

hasReference()

public boolean hasReference()

Required. Ground truth used to compare against the context.

optional string reference = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the reference field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RagContextRecallInstance.Builder newBuilderForType()
Returns
TypeDescription
RagContextRecallInstance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagContextRecallInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RagContextRecallInstance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RagContextRecallInstance.Builder toBuilder()
Returns
TypeDescription
RagContextRecallInstance.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException