Class RagContexts.Context.Builder (3.52.0)

public static final class RagContexts.Context.Builder extends GeneratedMessageV3.Builder<RagContexts.Context.Builder> implements RagContexts.ContextOrBuilder

A context of the query.

Protobuf type google.cloud.aiplatform.v1beta1.RagContexts.Context

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagContexts.Context.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagContexts.Context.Builder
Overrides

build()

public RagContexts.Context build()
Returns
Type Description
RagContexts.Context

buildPartial()

public RagContexts.Context buildPartial()
Returns
Type Description
RagContexts.Context

clear()

public RagContexts.Context.Builder clear()
Returns
Type Description
RagContexts.Context.Builder
Overrides

clearDistance()

public RagContexts.Context.Builder clearDistance()

The distance between the query dense embedding vector and the context text vector.

double distance = 3;

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagContexts.Context.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RagContexts.Context.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RagContexts.Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RagContexts.Context.Builder
Overrides

clearSourceUri()

public RagContexts.Context.Builder clearSourceUri()

For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

string source_uri = 1;

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

clearSparseDistance()

public RagContexts.Context.Builder clearSparseDistance()

The distance between the query sparse embedding vector and the context text vector.

double sparse_distance = 4;

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

clearText()

public RagContexts.Context.Builder clearText()

The text chunk.

string text = 2;

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

clone()

public RagContexts.Context.Builder clone()
Returns
Type Description
RagContexts.Context.Builder
Overrides

getDefaultInstanceForType()

public RagContexts.Context getDefaultInstanceForType()
Returns
Type Description
RagContexts.Context

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDistance()

public double getDistance()

The distance between the query dense embedding vector and the context text vector.

double distance = 3;

Returns
Type Description
double

The distance.

getSourceUri()

public String getSourceUri()

For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

string source_uri = 1;

Returns
Type Description
String

The sourceUri.

getSourceUriBytes()

public ByteString getSourceUriBytes()

For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

string source_uri = 1;

Returns
Type Description
ByteString

The bytes for sourceUri.

getSparseDistance()

public double getSparseDistance()

The distance between the query sparse embedding vector and the context text vector.

double sparse_distance = 4;

Returns
Type Description
double

The sparseDistance.

getText()

public String getText()

The text chunk.

string text = 2;

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

The text chunk.

string text = 2;

Returns
Type Description
ByteString

The bytes for text.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RagContexts.Context other)

public RagContexts.Context.Builder mergeFrom(RagContexts.Context other)
Parameter
Name Description
other RagContexts.Context
Returns
Type Description
RagContexts.Context.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagContexts.Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RagContexts.Context.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RagContexts.Context.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagContexts.Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagContexts.Context.Builder
Overrides

setDistance(double value)

public RagContexts.Context.Builder setDistance(double value)

The distance between the query dense embedding vector and the context text vector.

double distance = 3;

Parameter
Name Description
value double

The distance to set.

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RagContexts.Context.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RagContexts.Context.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RagContexts.Context.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RagContexts.Context.Builder
Overrides

setSourceUri(String value)

public RagContexts.Context.Builder setSourceUri(String value)

For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

string source_uri = 1;

Parameter
Name Description
value String

The sourceUri to set.

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

setSourceUriBytes(ByteString value)

public RagContexts.Context.Builder setSourceUriBytes(ByteString value)

For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

string source_uri = 1;

Parameter
Name Description
value ByteString

The bytes for sourceUri to set.

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

setSparseDistance(double value)

public RagContexts.Context.Builder setSparseDistance(double value)

The distance between the query sparse embedding vector and the context text vector.

double sparse_distance = 4;

Parameter
Name Description
value double

The sparseDistance to set.

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

setText(String value)

public RagContexts.Context.Builder setText(String value)

The text chunk.

string text = 2;

Parameter
Name Description
value String

The text to set.

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

setTextBytes(ByteString value)

public RagContexts.Context.Builder setTextBytes(ByteString value)

The text chunk.

string text = 2;

Parameter
Name Description
value ByteString

The bytes for text to set.

Returns
Type Description
RagContexts.Context.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RagContexts.Context.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RagContexts.Context.Builder
Overrides