Class Answer.Reference.ChunkInfo.Builder (0.81.0)

public static final class Answer.Reference.ChunkInfo.Builder extends GeneratedMessage.Builder<Answer.Reference.ChunkInfo.Builder> implements Answer.Reference.ChunkInfoOrBuilder

Chunk information.

Protobuf type google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo

Static Methods

getDescriptor()

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

Methods

build()

public Answer.Reference.ChunkInfo build()
Returns
Type Description
Answer.Reference.ChunkInfo

buildPartial()

public Answer.Reference.ChunkInfo buildPartial()
Returns
Type Description
Answer.Reference.ChunkInfo

clear()

public Answer.Reference.ChunkInfo.Builder clear()
Returns
Type Description
Answer.Reference.ChunkInfo.Builder
Overrides

clearChunk()

public Answer.Reference.ChunkInfo.Builder clearChunk()

Chunk resource name.

string chunk = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

clearContent()

public Answer.Reference.ChunkInfo.Builder clearContent()

Chunk textual content.

string content = 2;

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

clearDocumentMetadata()

public Answer.Reference.ChunkInfo.Builder clearDocumentMetadata()

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

clearRelevanceScore()

public Answer.Reference.ChunkInfo.Builder clearRelevanceScore()

The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.

optional float relevance_score = 3;

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

getChunk()

public String getChunk()

Chunk resource name.

string chunk = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The chunk.

getChunkBytes()

public ByteString getChunkBytes()

Chunk resource name.

string chunk = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for chunk.

getContent()

public String getContent()

Chunk textual content.

string content = 2;

Returns
Type Description
String

The content.

getContentBytes()

public ByteString getContentBytes()

Chunk textual content.

string content = 2;

Returns
Type Description
ByteString

The bytes for content.

getDefaultInstanceForType()

public Answer.Reference.ChunkInfo getDefaultInstanceForType()
Returns
Type Description
Answer.Reference.ChunkInfo

getDescriptorForType()

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

getDocumentMetadata()

public Answer.Reference.ChunkInfo.DocumentMetadata getDocumentMetadata()

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Returns
Type Description
Answer.Reference.ChunkInfo.DocumentMetadata

The documentMetadata.

getDocumentMetadataBuilder()

public Answer.Reference.ChunkInfo.DocumentMetadata.Builder getDocumentMetadataBuilder()

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Returns
Type Description
Answer.Reference.ChunkInfo.DocumentMetadata.Builder

getDocumentMetadataOrBuilder()

public Answer.Reference.ChunkInfo.DocumentMetadataOrBuilder getDocumentMetadataOrBuilder()

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Returns
Type Description
Answer.Reference.ChunkInfo.DocumentMetadataOrBuilder

getRelevanceScore()

public float getRelevanceScore()

The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.

optional float relevance_score = 3;

Returns
Type Description
float

The relevanceScore.

hasDocumentMetadata()

public boolean hasDocumentMetadata()

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Returns
Type Description
boolean

Whether the documentMetadata field is set.

hasRelevanceScore()

public boolean hasRelevanceScore()

The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.

optional float relevance_score = 3;

Returns
Type Description
boolean

Whether the relevanceScore field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocumentMetadata(Answer.Reference.ChunkInfo.DocumentMetadata value)

public Answer.Reference.ChunkInfo.Builder mergeDocumentMetadata(Answer.Reference.ChunkInfo.DocumentMetadata value)

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Parameter
Name Description
value Answer.Reference.ChunkInfo.DocumentMetadata
Returns
Type Description
Answer.Reference.ChunkInfo.Builder

mergeFrom(Answer.Reference.ChunkInfo other)

public Answer.Reference.ChunkInfo.Builder mergeFrom(Answer.Reference.ChunkInfo other)
Parameter
Name Description
other Answer.Reference.ChunkInfo
Returns
Type Description
Answer.Reference.ChunkInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Answer.Reference.ChunkInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.Reference.ChunkInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Answer.Reference.ChunkInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Answer.Reference.ChunkInfo.Builder
Overrides

setChunk(String value)

public Answer.Reference.ChunkInfo.Builder setChunk(String value)

Chunk resource name.

string chunk = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The chunk to set.

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

setChunkBytes(ByteString value)

public Answer.Reference.ChunkInfo.Builder setChunkBytes(ByteString value)

Chunk resource name.

string chunk = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for chunk to set.

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

setContent(String value)

public Answer.Reference.ChunkInfo.Builder setContent(String value)

Chunk textual content.

string content = 2;

Parameter
Name Description
value String

The content to set.

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

setContentBytes(ByteString value)

public Answer.Reference.ChunkInfo.Builder setContentBytes(ByteString value)

Chunk textual content.

string content = 2;

Parameter
Name Description
value ByteString

The bytes for content to set.

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.

setDocumentMetadata(Answer.Reference.ChunkInfo.DocumentMetadata value)

public Answer.Reference.ChunkInfo.Builder setDocumentMetadata(Answer.Reference.ChunkInfo.DocumentMetadata value)

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Parameter
Name Description
value Answer.Reference.ChunkInfo.DocumentMetadata
Returns
Type Description
Answer.Reference.ChunkInfo.Builder

setDocumentMetadata(Answer.Reference.ChunkInfo.DocumentMetadata.Builder builderForValue)

public Answer.Reference.ChunkInfo.Builder setDocumentMetadata(Answer.Reference.ChunkInfo.DocumentMetadata.Builder builderForValue)

Document metadata.

.google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata document_metadata = 4;

Parameter
Name Description
builderForValue Answer.Reference.ChunkInfo.DocumentMetadata.Builder
Returns
Type Description
Answer.Reference.ChunkInfo.Builder

setRelevanceScore(float value)

public Answer.Reference.ChunkInfo.Builder setRelevanceScore(float value)

The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.

optional float relevance_score = 3;

Parameter
Name Description
value float

The relevanceScore to set.

Returns
Type Description
Answer.Reference.ChunkInfo.Builder

This builder for chaining.