public static final class Chunk.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder> implements ChunkOrBuilder
Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.Protobuf type
google.cloud.discoveryengine.v1alpha.Chunk| Modifier and Type | Method and Description |
|---|---|
Chunk.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Chunk |
build() |
Chunk |
buildPartial() |
Chunk.Builder |
clear() |
Chunk.Builder |
clearChunkMetadata()
Output only.
|
Chunk.Builder |
clearContent()
Content is a string from a document (parsed content).
|
Chunk.Builder |
clearDerivedStructData()
Output only.
|
Chunk.Builder |
clearDocumentMetadata()
Metadata of the document from the current chunk.
|
Chunk.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Chunk.Builder |
clearId()
Unique chunk ID of the current chunk.
|
Chunk.Builder |
clearName()
The full resource name of the chunk.
|
Chunk.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Chunk.Builder |
clearPageSpan()
Page span of the chunk.
|
Chunk.Builder |
clearRelevanceScore()
Output only.
|
Chunk.Builder |
clone() |
Chunk.ChunkMetadata |
getChunkMetadata()
Output only.
|
Chunk.ChunkMetadata.Builder |
getChunkMetadataBuilder()
Output only.
|
Chunk.ChunkMetadataOrBuilder |
getChunkMetadataOrBuilder()
Output only.
|
String |
getContent()
Content is a string from a document (parsed content).
|
com.google.protobuf.ByteString |
getContentBytes()
Content is a string from a document (parsed content).
|
Chunk |
getDefaultInstanceForType() |
com.google.protobuf.Struct |
getDerivedStructData()
Output only.
|
com.google.protobuf.Struct.Builder |
getDerivedStructDataBuilder()
Output only.
|
com.google.protobuf.StructOrBuilder |
getDerivedStructDataOrBuilder()
Output only.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Chunk.DocumentMetadata |
getDocumentMetadata()
Metadata of the document from the current chunk.
|
Chunk.DocumentMetadata.Builder |
getDocumentMetadataBuilder()
Metadata of the document from the current chunk.
|
Chunk.DocumentMetadataOrBuilder |
getDocumentMetadataOrBuilder()
Metadata of the document from the current chunk.
|
String |
getId()
Unique chunk ID of the current chunk.
|
com.google.protobuf.ByteString |
getIdBytes()
Unique chunk ID of the current chunk.
|
String |
getName()
The full resource name of the chunk.
|
com.google.protobuf.ByteString |
getNameBytes()
The full resource name of the chunk.
|
Chunk.PageSpan |
getPageSpan()
Page span of the chunk.
|
Chunk.PageSpan.Builder |
getPageSpanBuilder()
Page span of the chunk.
|
Chunk.PageSpanOrBuilder |
getPageSpanOrBuilder()
Page span of the chunk.
|
double |
getRelevanceScore()
Output only.
|
boolean |
hasChunkMetadata()
Output only.
|
boolean |
hasDerivedStructData()
Output only.
|
boolean |
hasDocumentMetadata()
Metadata of the document from the current chunk.
|
boolean |
hasPageSpan()
Page span of the chunk.
|
boolean |
hasRelevanceScore()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Chunk.Builder |
mergeChunkMetadata(Chunk.ChunkMetadata value)
Output only.
|
Chunk.Builder |
mergeDerivedStructData(com.google.protobuf.Struct value)
Output only.
|
Chunk.Builder |
mergeDocumentMetadata(Chunk.DocumentMetadata value)
Metadata of the document from the current chunk.
|
Chunk.Builder |
mergeFrom(Chunk other) |
Chunk.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Chunk.Builder |
mergeFrom(com.google.protobuf.Message other) |
Chunk.Builder |
mergePageSpan(Chunk.PageSpan value)
Page span of the chunk.
|
Chunk.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Chunk.Builder |
setChunkMetadata(Chunk.ChunkMetadata.Builder builderForValue)
Output only.
|
Chunk.Builder |
setChunkMetadata(Chunk.ChunkMetadata value)
Output only.
|
Chunk.Builder |
setContent(String value)
Content is a string from a document (parsed content).
|
Chunk.Builder |
setContentBytes(com.google.protobuf.ByteString value)
Content is a string from a document (parsed content).
|
Chunk.Builder |
setDerivedStructData(com.google.protobuf.Struct.Builder builderForValue)
Output only.
|
Chunk.Builder |
setDerivedStructData(com.google.protobuf.Struct value)
Output only.
|
Chunk.Builder |
setDocumentMetadata(Chunk.DocumentMetadata.Builder builderForValue)
Metadata of the document from the current chunk.
|
Chunk.Builder |
setDocumentMetadata(Chunk.DocumentMetadata value)
Metadata of the document from the current chunk.
|
Chunk.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Chunk.Builder |
setId(String value)
Unique chunk ID of the current chunk.
|
Chunk.Builder |
setIdBytes(com.google.protobuf.ByteString value)
Unique chunk ID of the current chunk.
|
Chunk.Builder |
setName(String value)
The full resource name of the chunk.
|
Chunk.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The full resource name of the chunk.
|
Chunk.Builder |
setPageSpan(Chunk.PageSpan.Builder builderForValue)
Page span of the chunk.
|
Chunk.Builder |
setPageSpan(Chunk.PageSpan value)
Page span of the chunk.
|
Chunk.Builder |
setRelevanceScore(double value)
Output only.
|
Chunk.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Chunk.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Chunk build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Chunk buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Chunk.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Chunk.Builder>public Chunk.Builder mergeFrom(Chunk other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public Chunk.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Chunk.Builder>IOExceptionpublic String getName()
The full resource name of the chunk.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1;getName in interface ChunkOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The full resource name of the chunk.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1;getNameBytes in interface ChunkOrBuilderpublic Chunk.Builder setName(String value)
The full resource name of the chunk.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1;value - The name to set.public Chunk.Builder clearName()
The full resource name of the chunk.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1;public Chunk.Builder setNameBytes(com.google.protobuf.ByteString value)
The full resource name of the chunk.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1;value - The bytes for name to set.public String getId()
Unique chunk ID of the current chunk.
string id = 2;getId in interface ChunkOrBuilderpublic com.google.protobuf.ByteString getIdBytes()
Unique chunk ID of the current chunk.
string id = 2;getIdBytes in interface ChunkOrBuilderpublic Chunk.Builder setId(String value)
Unique chunk ID of the current chunk.
string id = 2;value - The id to set.public Chunk.Builder clearId()
Unique chunk ID of the current chunk.
string id = 2;public Chunk.Builder setIdBytes(com.google.protobuf.ByteString value)
Unique chunk ID of the current chunk.
string id = 2;value - The bytes for id to set.public String getContent()
Content is a string from a document (parsed content).
string content = 3;getContent in interface ChunkOrBuilderpublic com.google.protobuf.ByteString getContentBytes()
Content is a string from a document (parsed content).
string content = 3;getContentBytes in interface ChunkOrBuilderpublic Chunk.Builder setContent(String value)
Content is a string from a document (parsed content).
string content = 3;value - The content to set.public Chunk.Builder clearContent()
Content is a string from a document (parsed content).
string content = 3;public Chunk.Builder setContentBytes(com.google.protobuf.ByteString value)
Content is a string from a document (parsed content).
string content = 3;value - The bytes for content to set.public boolean hasRelevanceScore()
Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on [SearchService.SearchResponse][].
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasRelevanceScore in interface ChunkOrBuilderpublic double getRelevanceScore()
Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on [SearchService.SearchResponse][].
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRelevanceScore in interface ChunkOrBuilderpublic Chunk.Builder setRelevanceScore(double value)
Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on [SearchService.SearchResponse][].
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The relevanceScore to set.public Chunk.Builder clearRelevanceScore()
Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on [SearchService.SearchResponse][].
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasDocumentMetadata()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
hasDocumentMetadata in interface ChunkOrBuilderpublic Chunk.DocumentMetadata getDocumentMetadata()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
getDocumentMetadata in interface ChunkOrBuilderpublic Chunk.Builder setDocumentMetadata(Chunk.DocumentMetadata value)
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
public Chunk.Builder setDocumentMetadata(Chunk.DocumentMetadata.Builder builderForValue)
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
public Chunk.Builder mergeDocumentMetadata(Chunk.DocumentMetadata value)
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
public Chunk.Builder clearDocumentMetadata()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
public Chunk.DocumentMetadata.Builder getDocumentMetadataBuilder()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
public Chunk.DocumentMetadataOrBuilder getDocumentMetadataOrBuilder()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.DocumentMetadata document_metadata = 5;
getDocumentMetadataOrBuilder in interface ChunkOrBuilderpublic boolean hasDerivedStructData()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasDerivedStructData in interface ChunkOrBuilderpublic com.google.protobuf.Struct getDerivedStructData()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDerivedStructData in interface ChunkOrBuilderpublic Chunk.Builder setDerivedStructData(com.google.protobuf.Struct value)
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.Builder setDerivedStructData(com.google.protobuf.Struct.Builder builderForValue)
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.Builder mergeDerivedStructData(com.google.protobuf.Struct value)
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.Builder clearDerivedStructData()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Struct.Builder getDerivedStructDataBuilder()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.StructOrBuilder getDerivedStructDataOrBuilder()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDerivedStructDataOrBuilder in interface ChunkOrBuilderpublic boolean hasPageSpan()
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;hasPageSpan in interface ChunkOrBuilderpublic Chunk.PageSpan getPageSpan()
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;getPageSpan in interface ChunkOrBuilderpublic Chunk.Builder setPageSpan(Chunk.PageSpan value)
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;public Chunk.Builder setPageSpan(Chunk.PageSpan.Builder builderForValue)
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;public Chunk.Builder mergePageSpan(Chunk.PageSpan value)
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;public Chunk.Builder clearPageSpan()
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;public Chunk.PageSpan.Builder getPageSpanBuilder()
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;public Chunk.PageSpanOrBuilder getPageSpanOrBuilder()
Page span of the chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.PageSpan page_span = 6;getPageSpanOrBuilder in interface ChunkOrBuilderpublic boolean hasChunkMetadata()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasChunkMetadata in interface ChunkOrBuilderpublic Chunk.ChunkMetadata getChunkMetadata()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getChunkMetadata in interface ChunkOrBuilderpublic Chunk.Builder setChunkMetadata(Chunk.ChunkMetadata value)
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.Builder setChunkMetadata(Chunk.ChunkMetadata.Builder builderForValue)
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.Builder mergeChunkMetadata(Chunk.ChunkMetadata value)
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.Builder clearChunkMetadata()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.ChunkMetadata.Builder getChunkMetadataBuilder()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Chunk.ChunkMetadataOrBuilder getChunkMetadataOrBuilder()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1alpha.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getChunkMetadataOrBuilder in interface ChunkOrBuilderpublic final Chunk.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>public final Chunk.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Chunk.Builder>Copyright © 2024 Google LLC. All rights reserved.