Class RagQuery (3.43.0)

public final class RagQuery extends GeneratedMessageV3 implements RagQueryOrBuilder

A query to retrieve relevant contexts.

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery

Implements

RagQueryOrBuilder

Static Fields

SIMILARITY_TOP_K_FIELD_NUMBER

public static final int SIMILARITY_TOP_K_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 RagQuery getDefaultInstance()
Returns
Type Description
RagQuery

getDescriptor()

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

newBuilder()

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

newBuilder(RagQuery prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RagQuery getDefaultInstanceForType()
Returns
Type Description
RagQuery

getParserForType()

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

getQueryCase()

public RagQuery.QueryCase getQueryCase()
Returns
Type Description
RagQuery.QueryCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSimilarityTopK()

public int getSimilarityTopK()

Optional. The number of contexts to retrieve.

int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The similarityTopK.

getText()

public String getText()

Optional. The query in text format to get relevant contexts.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

Optional. The query in text format to get relevant contexts.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for text.

hasText()

public boolean hasText()

Optional. The query in text format to get relevant contexts.

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the text 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 RagQuery.Builder newBuilderForType()
Returns
Type Description
RagQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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