- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class RagQuery.Builder extends GeneratedMessageV3.Builder<RagQuery.Builder> implements RagQueryOrBuilder
A query to retrieve relevant contexts.
Protobuf type google.cloud.aiplatform.v1beta1.RagQuery
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RagQuery.BuilderImplements
RagQueryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RagQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
build()
public RagQuery build()
Returns | |
---|---|
Type | Description |
RagQuery |
buildPartial()
public RagQuery buildPartial()
Returns | |
---|---|
Type | Description |
RagQuery |
clear()
public RagQuery.Builder clear()
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
clearField(Descriptors.FieldDescriptor field)
public RagQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public RagQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
clearQuery()
public RagQuery.Builder clearQuery()
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
clearRagRetrievalConfig()
public RagQuery.Builder clearRagRetrievalConfig()
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
clearRanking() (deprecated)
public RagQuery.Builder clearRanking()
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
clearSimilarityTopK() (deprecated)
public RagQuery.Builder clearSimilarityTopK()
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];
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
This builder for chaining. |
clearText()
public RagQuery.Builder clearText()
Optional. The query in text format to get relevant contexts.
string text = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
This builder for chaining. |
clone()
public RagQuery.Builder clone()
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
getDefaultInstanceForType()
public RagQuery getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
RagQuery |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getQueryCase()
public RagQuery.QueryCase getQueryCase()
Returns | |
---|---|
Type | Description |
RagQuery.QueryCase |
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];
Returns | |
---|---|
Type | Description |
RagRetrievalConfig |
The ragRetrievalConfig. |
getRagRetrievalConfigBuilder()
public RagRetrievalConfig.Builder getRagRetrievalConfigBuilder()
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagRetrievalConfig.Builder |
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];
Returns | |
---|---|
Type | Description |
RagRetrievalConfigOrBuilder |
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];
Returns | |
---|---|
Type | Description |
RagQuery.Ranking |
The ranking. |
getRankingBuilder() (deprecated)
public RagQuery.Ranking.Builder getRankingBuilder()
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagQuery.Ranking.Builder |
getRankingOrBuilder() (deprecated)
public RagQuery.RankingOrBuilder getRankingOrBuilder()
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
RagQuery.RankingOrBuilder |
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];
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. |
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];
Returns | |
---|---|
Type | Description |
boolean |
Whether the ragRetrievalConfig field is set. |
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];
Returns | |
---|---|
Type | Description |
boolean |
Whether the ranking field is set. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(RagQuery other)
public RagQuery.Builder mergeFrom(RagQuery other)
Parameter | |
---|---|
Name | Description |
other |
RagQuery |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RagQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public RagQuery.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
mergeRagRetrievalConfig(RagRetrievalConfig value)
public RagQuery.Builder mergeRagRetrievalConfig(RagRetrievalConfig value)
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
RagRetrievalConfig |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
mergeRanking(RagQuery.Ranking value) (deprecated)
public RagQuery.Builder mergeRanking(RagQuery.Ranking value)
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
RagQuery.Ranking |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RagQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public RagQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setRagRetrievalConfig(RagRetrievalConfig value)
public RagQuery.Builder setRagRetrievalConfig(RagRetrievalConfig value)
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
RagRetrievalConfig |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
public RagQuery.Builder setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
Optional. The retrieval config for the query.
.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
RagRetrievalConfig.Builder |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setRanking(RagQuery.Ranking value) (deprecated)
public RagQuery.Builder setRanking(RagQuery.Ranking value)
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
RagQuery.Ranking |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setRanking(RagQuery.Ranking.Builder builderForValue) (deprecated)
public RagQuery.Builder setRanking(RagQuery.Ranking.Builder builderForValue)
Optional. Configurations for hybrid search results ranking.
.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
RagQuery.Ranking.Builder |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RagQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
setSimilarityTopK(int value) (deprecated)
public RagQuery.Builder setSimilarityTopK(int value)
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];
Parameter | |
---|---|
Name | Description |
value |
int The similarityTopK to set. |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
This builder for chaining. |
setText(String value)
public RagQuery.Builder setText(String value)
Optional. The query in text format to get relevant contexts.
string text = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The text to set. |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
This builder for chaining. |
setTextBytes(ByteString value)
public RagQuery.Builder setTextBytes(ByteString value)
Optional. The query in text format to get relevant contexts.
string text = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for text to set. |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RagQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
RagQuery.Builder |