com.google.cloud.aiplatform.v1beta1

Class RagQuery

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.RagQuery

All Implemented Interfaces:

RagQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RagQuery
extends com.google.protobuf.GeneratedMessageV3
implements RagQueryOrBuilder

 A query to retrieve relevant contexts.
 

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RagQuery.Builder A query to retrieve relevant contexts.
static class	RagQuery.QueryCase
static class	RagQuery.Ranking Configurations for hybrid search results ranking.
static interface	RagQuery.RankingOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	RAG_RETRIEVAL_CONFIG_FIELD_NUMBER
static int	RANKING_FIELD_NUMBER
static int	SIMILARITY_TOP_K_FIELD_NUMBER
static int	TEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static RagQuery	getDefaultInstance()
RagQuery	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<RagQuery>	getParserForType()
RagQuery.QueryCase	getQueryCase()
RagRetrievalConfig	getRagRetrievalConfig() Optional.
RagRetrievalConfigOrBuilder	getRagRetrievalConfigOrBuilder() Optional.
RagQuery.Ranking	getRanking() Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=95
RagQuery.RankingOrBuilder	getRankingOrBuilder() Deprecated.
int	getSerializedSize()
int	getSimilarityTopK() Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=91
String	getText() Optional.
com.google.protobuf.ByteString	getTextBytes() Optional.
int	hashCode()
boolean	hasRagRetrievalConfig() Optional.
boolean	hasRanking() Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=95
boolean	hasText() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RagQuery.Builder	newBuilder()
static RagQuery.Builder	newBuilder(RagQuery prototype)
RagQuery.Builder	newBuilderForType()
protected RagQuery.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RagQuery	parseDelimitedFrom(InputStream input)
static RagQuery	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagQuery	parseFrom(byte[] data)
static RagQuery	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagQuery	parseFrom(ByteBuffer data)
static RagQuery	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagQuery	parseFrom(com.google.protobuf.ByteString data)
static RagQuery	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagQuery	parseFrom(com.google.protobuf.CodedInputStream input)
static RagQuery	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagQuery	parseFrom(InputStream input)
static RagQuery	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RagQuery>	parser()
RagQuery.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

See Also:

Constant Field Values

SIMILARITY_TOP_K_FIELD_NUMBER

public static final int SIMILARITY_TOP_K_FIELD_NUMBER

See Also:

Constant Field Values

RANKING_FIELD_NUMBER

public static final int RANKING_FIELD_NUMBER

See Also:

Constant Field Values

RAG_RETRIEVAL_CONFIG_FIELD_NUMBER

public static final int RAG_RETRIEVAL_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getQueryCase

public RagQuery.QueryCase getQueryCase()

Specified by:

getQueryCase in interface RagQueryOrBuilder

hasText

public boolean hasText()

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

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

Specified by:

hasText in interface RagQueryOrBuilder

Returns:

Whether the text field is set.

getText

public String getText()

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

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

Specified by:

getText in interface RagQueryOrBuilder

Returns:

The text.

getTextBytes

public com.google.protobuf.ByteString getTextBytes()

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

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

Specified by:

getTextBytes in interface RagQueryOrBuilder

Returns:

The bytes for text.

getSimilarityTopK

@Deprecated
public int getSimilarityTopK()

Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=91

 Optional. The number of contexts to retrieve.
 

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

Specified by:

getSimilarityTopK in interface RagQueryOrBuilder

Returns:

The similarityTopK.

hasRanking

@Deprecated
public boolean hasRanking()

Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=95

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRanking in interface RagQueryOrBuilder

Returns:

Whether the ranking field is set.

getRanking

@Deprecated
public RagQuery.Ranking getRanking()

Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=95

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Specified by:

getRanking in interface RagQueryOrBuilder

Returns:

The ranking.

getRankingOrBuilder

@Deprecated
public RagQuery.RankingOrBuilder getRankingOrBuilder()

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Specified by:

getRankingOrBuilder in interface RagQueryOrBuilder

hasRagRetrievalConfig

public boolean hasRagRetrievalConfig()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRagRetrievalConfig in interface RagQueryOrBuilder

Returns:

Whether the ragRetrievalConfig field is set.

getRagRetrievalConfig

public RagRetrievalConfig getRagRetrievalConfig()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagRetrievalConfig in interface RagQueryOrBuilder

Returns:

The ragRetrievalConfig.

getRagRetrievalConfigOrBuilder

public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagRetrievalConfigOrBuilder in interface RagQueryOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RagQuery parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagQuery parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagQuery parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagQuery parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagQuery parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagQuery parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagQuery parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static RagQuery parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagQuery parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagQuery parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static RagQuery parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static RagQuery parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public RagQuery.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RagQuery.Builder newBuilder()

newBuilder

public static RagQuery.Builder newBuilder(RagQuery prototype)

toBuilder

public RagQuery.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RagQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RagQuery getDefaultInstance()

parser

public static com.google.protobuf.Parser<RagQuery> parser()

getParserForType

public com.google.protobuf.Parser<RagQuery> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RagQuery getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder